github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/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  ```hcl
    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    allow_unverified_ssl = "${var.vcd_allow_unverified_ssl}"
    29  }
    30  
    31  # Create a new network
    32  resource "vcd_network" "net" {
    33    # ...
    34  }
    35  ```
    36  
    37  ## Argument Reference
    38  
    39  The following arguments are used to configure the VMware vCloud Director Provider:
    40  
    41  * `user` - (Required) This is the username for vCloud Director API operations. Can also
    42    be specified with the `VCD_USER` environment variable.
    43  * `password` - (Required) This is the password for vCloud Director API operations. Can
    44    also be specified with the `VCD_PASSWORD` environment variable.
    45  * `org` - (Required) This is the vCloud Director Org on which to run API
    46    operations. Can also be specified with the `VCD_ORG` environment
    47    variable.
    48  * `url` - (Required) This is the URL for the vCloud Director API endpoint. e.g.
    49    https://server.domain.com/api. Can also be specified with the `VCD_URL` environment variable.
    50  * `vdc` - (Optional) This is the virtual datacenter within vCloud Director to run
    51    API operations against. If not set the plugin will select the first virtual
    52    datacenter available to your Org. Can also be specified with the `VCD_VDC` environment
    53    variable.
    54  * `maxRetryTimeout` - (Optional) This provides you with the ability to specify the maximum
    55    amount of time (in seconds) you are prepared to wait for interactions on resources managed
    56    by vCloud Director to be successful. If a resource action fails, the action will be retried
    57    (as long as it is still within the `maxRetryTimeout` value) to try and ensure success.
    58    Defaults to 60 seconds if not set.
    59    Can also be specified with the `VCD_MAX_RETRY_TIMEOUT` environment variable.
    60  * `allow_unverified_ssl` - (Optional) Boolean that can be set to true to
    61    disable SSL certificate verification. This should be used with care as it
    62    could allow an attacker to intercept your auth token. If omitted, default
    63    value is false. Can also be specified with the
    64    `VCD_ALLOW_UNVERIFIED_SSL` environment variable.