-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for data collector, region and region enumeration d…
…ata sources (#283) * Add documentation for data collector, region and region enumeration data sources Add documentation for IaaS data sources: data "vra_data_collector" data "vra_region" data "vra_region_enumeration" data "vra_region_enumeration_aws" data "vra_region_enumeration_azure" data "vra_region_enumeration_gcp" data "vra_region_enumeration_vmc" data "vra_region_enumeration_vsphere" Signed-off-by: Sagar <[email protected]>
1 parent
035e407
commit ed1e4cd
Showing
8 changed files
with
290 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_data_collector" | ||
description: |- | ||
Provides a data lookup for data collector data source. | ||
--- | ||
|
||
# Data Source: vra_data_collector | ||
## Example Usages | ||
|
||
This is an example of how to lookup a data collector. | ||
|
||
**Data collector data source by its name:** | ||
```hcl | ||
data "vra_data_collector" "this" { | ||
name = var.data_collector_name | ||
} | ||
``` | ||
The data collector data source supports the following arguments: | ||
|
||
## Argument Reference | ||
* `name` - (Required) Data collector name. Example: Datacollector1 | ||
|
||
## Attribute Reference | ||
* `hostname` - Data collector host name. Example: dc1-lnd.mycompany.com | ||
|
||
* `ip_address` - IPv4 Address of the data collector VM. Example: 10.0.0.1 | ||
|
||
* `status` - Current status of the data collector. Example: ACTIVE, INACTIVE | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region" | ||
description: |- | ||
Provides a data lookup for region data source. | ||
--- | ||
|
||
# Data Source: vra_region | ||
## Example Usages | ||
|
||
This is an example of how to read a region data source. | ||
|
||
**Region data source by cloud account Id and region:** | ||
```hcl | ||
data "vra_region" "this" { | ||
cloud_account_id = var.vra_cloud_account_id | ||
region = "us-east-1" | ||
} | ||
``` | ||
|
||
The region data source supports the following arguments: | ||
|
||
## Argument Reference | ||
* `cloud_account_id` - (Required) The Cloud Account ID. | ||
|
||
* `region` - (Required) The specific region associated with the cloud account. | ||
|
||
## Attribute Reference | ||
* `id` - The ID of the given region within the cloud account. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region_enumeration" | ||
description: |- | ||
Provides a data lookup for region enumeration data source. | ||
--- | ||
|
||
# Data Source: vra_region_enumeration | ||
## Example Usages | ||
|
||
This is an example of how to lookup a region enumeration data source. | ||
|
||
DeprecationMessage: 'region_enumeration' is deprecated. Use 'region_enumeration_vsphere' instead. | ||
|
||
**Region enumeration data source for vSphere** | ||
```hcl | ||
data "vra_region_enumeration_vsphere" "this" { | ||
accept_self_signed_cert = false | ||
dcid = var.vra_data_collector_id | ||
hostname = var.hostname | ||
password = var.password | ||
username = var.username | ||
} | ||
``` | ||
|
||
The region enumeration data source supports the following arguments: | ||
|
||
## Argument Reference | ||
* `accept_self_signed_cert` - (Optional) Accept self signed certificate when connecting to vSphere. Example: false | ||
|
||
* `dcid` - (Optional) ID of a data collector vm deployed in the on premise infrastructure. Example: d5316b00-f3b8-4895-9e9a-c4b98649c2ca | ||
|
||
* `hostname` - (Required) Host name for the cloud account endpoint. Example: dc1-lnd.mycompany.com | ||
|
||
* `password` - (Required) Password for the user used to authenticate with the cloud Account | ||
|
||
* `username` - (Required) Username to authenticate with the cloud account | ||
|
||
## Attribute Reference | ||
* `regions` - A set of datacenter managed object reference identifiers to enable provisioning on. Example: Datacenter:datacenter-2 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region_enumeration_aws" | ||
description: |- | ||
Provides a data lookup for region enumeration for AWS cloud account. | ||
--- | ||
|
||
# Data Source: vra_region_enumeration_aws | ||
## Example Usages | ||
|
||
This is an example of how to lookup a region enumeration data source for AWS cloud account. | ||
|
||
**Region enumeration data source for AWS, by the AWS account access key and secret key:** | ||
```hcl | ||
data "vra_region_enumeration_aws" "this" { | ||
access_key = var.access_key | ||
secret_key = var.secret_key | ||
} | ||
``` | ||
|
||
The region enumeration data source for AWS cloud account supports the following arguments: | ||
|
||
## Argument Reference | ||
* `access_key` - (Optional) Aws Access key ID. | ||
|
||
* `secret_key` - (Required) Aws Secret Access Key. | ||
|
||
## Attribute Reference | ||
* `regions` - A set of Region names to enable provisioning on. Example: us-east-2, ap-northeast-1 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region_enumeration_azure" | ||
description: |- | ||
Provides a data lookup for region enumeration for Azure cloud account. | ||
--- | ||
|
||
# Data Source: vra_region_enumeration_azure | ||
## Example Usages | ||
|
||
This is an example of how to lookup a region enumeration data source for Azure cloud account. | ||
|
||
**Region enumeration data source for Azure** | ||
```hcl | ||
data "vra_region_enumeration_azure" "this" { | ||
application_id = var.application_id | ||
application_key = var.application_key | ||
subscription_id = var.subscription_id | ||
tenant_id = var.tenant_id | ||
} | ||
``` | ||
|
||
The region enumeration data source for Azure cloud account supports the following arguments: | ||
|
||
## Argument Reference | ||
* `application_id` - (Required) Azure Client Application ID | ||
|
||
* `application_key` - (Required) Azure Client Application Secret Key | ||
|
||
* `subscription_id` - (Required) Azure Subscribtion ID | ||
|
||
* `tenant_id` - (Required) Azure Tenant ID | ||
|
||
## Attribute Reference | ||
* `regions` - A set of Region names to enable provisioning on. Example: northamerica-northeast1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region_enumeration_gcp" | ||
description: |- | ||
Provides a data lookup for region enumeration for GCP cloud account. | ||
--- | ||
|
||
# Data Source: vra_region_enumeration_gcp | ||
## Example Usages | ||
|
||
This is an example of how to lookup a region enumeration data source for GCP cloud account. | ||
|
||
**Region enumeration data source for GCP** | ||
```hcl | ||
data "vra_region_enumeration_gcp" "this" { | ||
client_email = var.client_email | ||
private_key_id = var.private_key_id | ||
private_key = var.private_key | ||
project_id = var.project_id | ||
} | ||
``` | ||
|
||
The region enumeration data source for GCP cloud account supports the following arguments: | ||
|
||
## Argument Reference | ||
* `client_email` - (Required) Client E-mail ID. | ||
|
||
* `private_key` - (Required) GCP Private key. | ||
|
||
* `private_key_id` - (Required) GCP Private key ID. | ||
|
||
* `project_id` - (Required) GCP Project ID. | ||
|
||
## Attribute Reference | ||
* `regions` - A set of Region names to enable provisioning on. Example: northamerica-northeast1 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region_enumeration_vmc" | ||
description: |- | ||
Provides a data lookup for region enumeration for VMC cloud account. | ||
--- | ||
|
||
# Data Source: vra_region_enumeration_vmc | ||
## Example Usages | ||
|
||
This is an example of how to lookup a region enumeration data source for VMC cloud account. | ||
|
||
**Region enumeration data source for VMC** | ||
```hcl | ||
data "vra_region_enumeration_vmc" "this" { | ||
accept_self_signed_cert = true | ||
dc_id = var.vra_data_collector_id | ||
api_token = var.api_token | ||
sddc_name = var.sddc_name | ||
vcenter_hostname = var.vcenter_hostname | ||
vcenter_password = var.vcenter_password | ||
vcenter_username = var.vcenter_username | ||
} | ||
``` | ||
|
||
The region enumeration data source for VMC cloud account supports the following arguments: | ||
|
||
## Argument Reference | ||
* `accept_self_signed_cert` - (Optional) Accept self signed certificate when connecting to vSphere. Example: false | ||
|
||
* `api_token` - (Required) API Token for the cloud account endpoint. | ||
|
||
* `dc_id` - (Optional) ID of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. | ||
|
||
* `sddc_name` - (Required) Identifier of the on-premise SDDC to be used by this cloud account. | ||
|
||
* `vcenter_hostname` - (Required) The IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter. | ||
|
||
* `vcenter_password` - (Required) Password for the user used to authenticate with the cloud Account | ||
|
||
* `vcenter_username` - (Required) vCenter user name for the specified SDDC.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials. | ||
|
||
## Attribute Reference | ||
* `regions` - A set of Region names to enable provisioning on. Example: northamerica-northeast1 |
40 changes: 40 additions & 0 deletions
40
website/docs/d/vra_region_enumeration_vsphere.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
layout: "vra" | ||
page_title: "VMware vRealize Automation: vra_region_enumeration_vsphere" | ||
description: |- | ||
Provides a data lookup for region enumeration for vSphere cloud account. | ||
--- | ||
|
||
# Data Source: vra_region_enumeration_vsphere | ||
## Example Usages | ||
|
||
This is an example of how to lookup a region enumeration data source for vSphere cloud account. | ||
|
||
**Region enumeration data source for vSphere** | ||
```hcl | ||
data "vra_region_enumeration_vsphere" "this" { | ||
accept_self_signed_cert = false | ||
dcid = var.vra_data_collector_id | ||
hostname = this.hostname | ||
password = this.password | ||
username = this.username | ||
} | ||
``` | ||
|
||
The region enumeration data source for vSphere cloud account supports the following arguments: | ||
|
||
## Argument Reference | ||
* `accept_self_signed_cert` - (Optional) Accept self signed certificate when connecting to vSphere. Example: false | ||
|
||
* `dcid` - (Required) ID of a data collector vm deployed in the on premise infrastructure. Example: d5316b00-f3b8-4895-9e9a-c4b98649c2ca | ||
|
||
* `hostname` - (Required) Host name for the cloud account endpoint. Example: dc1-lnd.mycompany.com | ||
|
||
* `password` - (Required) Password for the user used to authenticate with the cloud Account | ||
|
||
* `username` - (Required) Username to authenticate with the cloud account | ||
|
||
## Attribute Reference | ||
* `regions` - A set of datacenter managed object reference identifiers to enable provisioning on. Example: Datacenter:datacenter-2 |