github.com/turtlemonvh/terraform@v0.6.9-0.20151204001754-8e40b6b855e8/website/source/docs/providers/vcd/index.html.markdown (about)

     1  ---
     2  layout: "vcd"
     3  page_title: "Provider: VMware vCloudDirector"
     4  sidebar_current: "docs-vcd-index"
     5  description: |-
     6    The VMware vCloud Director provider is used to interact with the resources supported by VMware vCloud Director. The provider needs to be configured with the proper credentials before it can be used.
     7  ---
     8  
     9  # VMware vCloud Director Provider
    10  
    11  The VMware vCloud Director provider is used to interact with the resources supported by VMware vCloud Director. The provider needs to be configured with the proper credentials before it can be used.
    12  
    13  Use the navigation to the left to read about the available resources.
    14  
    15  ~> **NOTE:** The VMware vCloud Director Provider currently represents _initial support_ and therefore may undergo significant changes as the community improves it.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  # Configure the VMware vCloud Director Provider
    21  provider "vcd" {
    22  	user            = "${var.vcd_user}"
    23  	password        = "${var.vcd_pass}"
    24  	org             = "${var.vcd_org}"
    25  	url             = "${var.vcd_url}"
    26  	vdc             = "${var.vcd_vdc}"
    27  	maxRetryTimeout = "${var.vcd_maxRetryTimeout}"	
    28  }
    29  
    30  # Create a new network
    31  resource "vcd_network" "net" {
    32      ...
    33  }
    34  ```
    35  
    36  ## Argument Reference
    37  
    38  The following arguments are used to configure the VMware vCloud Director Provider:
    39  
    40  * `user` - (Required) This is the username for vCloud Director API operations. Can also
    41    be specified with the `VCD_USER` environment variable.
    42  * `password` - (Required) This is the password for vCloud Director API operations. Can
    43    also be specified with the `VCD_PASSWORD` environment variable.
    44  * `org` - (Required) This is the vCloud Director Org on which to run API
    45    operations. Can also be specified with the `VCD_ORG` environment
    46    variable.
    47  * `url` - (Required) This is the URL for the vCloud Director API.
    48    Can also be specified with the `VCD_URL` environment variable.
    49  * `vdc` - (Optional) This is the virtual datacenter within vCloud Director to run
    50    API operations against. If not set the plugin will select the first virtual
    51    datacenter available to your Org. Can also be specified with the `VCD_VDC` environment
    52    variable.
    53  * `maxRetryTimeout` - (Optional) This provides you with the ability to specify the maximum
    54    amount of time (in seconds) you are prepared to wait for interactions on resources managed
    55    by vCloud Director to be successful. If a resource action fails, the action will be retried
    56    (as long as it is still within the `maxRetryTimeout` value) to try and ensure success. 
    57    Defaults to 60 seconds if not set.
    58    Can also be specified with the `VCD_MAX_RETRY_TIMEOUT` environment variable.