Skip to content

Commit

Permalink
Docs generation (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
J0HNB0Y authored Feb 21, 2022
1 parent ef2a999 commit 098a629
Show file tree
Hide file tree
Showing 51 changed files with 1,097 additions and 289 deletions.
8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,5 @@ data "hpegl_vmaas_cloud" "cloud" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


10 changes: 1 addition & 9 deletions docs/data-sources/vmaas_cloud_folder.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The hpegl_vmaas_cloud_folder data source can be used to discover the ID for a fo
data "hpegl_vmaas_cloud_folder" "compute_folder" {
cloud_id = data.hpegl_vmaas_cloud.cloud.id
name = "ComputeFolder "
name = "ComputeFolder"
}
```

Expand All @@ -36,17 +36,9 @@ data "hpegl_vmaas_cloud_folder" "compute_folder" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- **code** (String) External ID or code for the folder.

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_datastore.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,5 @@ data "hpegl_vmaas_datastore" "c_3par" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


42 changes: 42 additions & 0 deletions docs/data-sources/vmaas_edge_cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "hpegl_vmaas_edge_cluster Data Source - terraform-provider-hpegl"
subcategory: ""
description: |-
The hpeglvmaasedgecluster data source can be used to discover the Provider ID of a hpegl vmaas Edge cluster.
This can then be used with resources or data sources that require a hpeglvmaasedgecluster
---

# hpegl_vmaas_edge_cluster (Data Source)

The hpegl_vmaas_edge_cluster data source can be used to discover the Provider ID of a hpegl vmaas Edge cluster.
This can then be used with resources or data sources that require a hpegl_vmaas_edge_cluster

## Example Usage

```terraform
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP
data "hpegl_vmaas_edge_cluster" "tf_edge_cluster" {
name = "nsx_edge_cluster"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **name** (String) Name of the Edge Cluster as it appears on GLPC Portal. If there is no Edge Cluster with this name, a 'NOT FOUND' error will returned.

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **external_id** (String)
- **internal_id** (String)
- **provider_id** (String) ProviderId of the Edge Cluster. Use the provider_id as EdgeCluster while creating NSX-T Router


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,9 @@ data "hpegl_vmaas_environment" "staging" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- **code** (String) code of each environment

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,5 @@ data "hpegl_vmaas_group" "default_group" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,5 @@ data "hpegl_vmaas_layout" "vmware_centos" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


42 changes: 42 additions & 0 deletions docs/data-sources/vmaas_network_domain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "hpegl_vmaas_network_domain Data Source - terraform-provider-hpegl"
subcategory: ""
description: |-
The hpeglvmaasnetworkdomain data source can be used to discover the ID of a hpeglvmaasnetworkdomain.
This can then be used with resources or data sources that require a hpeglvmaasnetworkdomain
such as the hpeglvmaas_network
---

# hpegl_vmaas_network_domain (Data Source)

The hpegl_vmaas_network_domain data source can be used to discover the ID of a hpegl_vmaas_network_domain.
This can then be used with resources or data sources that require a hpegl_vmaas_network_domain
such as the hpegl_vmaas_network

## Example Usage

```terraform
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP
data "hpegl_vmaas_network_domain" "tf_domain" {
name = "test_domain"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **name** (String) Name of the network domain as it appears on GLPC Portal. If there is no network domain with this name, a 'NOT FOUND' error will returned.

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **active** (Boolean) Flag denotes active domain or not


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_network_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,9 @@ data "hpegl_vmaas_network_interface" "e1000" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- **code** (String) code corresponding to the network interface type

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


38 changes: 38 additions & 0 deletions docs/data-sources/vmaas_network_proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "hpegl_vmaas_network_proxy Data Source - terraform-provider-hpegl"
subcategory: ""
description: |-
The hpeglvmaasnetworkproxy data source can be used to discover the ID of a hpeglvmaasnetworkproxy.
This can then be used with resources or data sources that require a hpeglvmaasnetworkproxy,
such as the hpeglvmaas_network resource (for creating non NSX-T segments).
---

# hpegl_vmaas_network_proxy (Data Source)

The hpegl_vmaas_network_proxy data source can be used to discover the ID of a hpegl_vmaas_network_proxy.
This can then be used with resources or data sources that require a hpegl_vmaas_network_proxy,
such as the hpegl_vmaas_network resource (for creating non NSX-T segments).

## Example Usage

```terraform
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP
data "hpegl_vmaas_network_proxy" "tf_proxy" {
name = "test_proxy"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **name** (String) Name of the network proxy

### Optional

- **id** (String) The ID of this resource.


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,5 @@ data "hpegl_vmaas_plan" "g1_small" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_power_schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,5 @@ data "hpegl_vmaas_power_schedule" "weekday" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_resource_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,5 @@ data "hpegl_vmaas_resource_pool" "cluster" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


52 changes: 52 additions & 0 deletions docs/data-sources/vmaas_router.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "hpegl_vmaas_router Data Source - terraform-provider-hpegl"
subcategory: ""
description: |-
The hpeglvmaasrouter data source can be used to discover the ID of a hpegl vmaas router.
This can then be used with resources or data sources that require a hpeglvmaasrouter,
such as the hpeglvmaasrouter resource.
---

# hpegl_vmaas_router (Data Source)

The hpegl_vmaas_router data source can be used to discover the ID of a hpegl vmaas router.
This can then be used with resources or data sources that require a hpegl_vmaas_router,
such as the hpegl_vmaas_router resource.

## Example Usage

```terraform
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP
data "hpegl_vmaas_router" "tier0_router" {
name = "tier0_gateway"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **name** (String) Name of the Router as it appears on GLPC Portal. If there is no Router with this name, a 'NOT FOUND' error will returned.

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **interfaces** (List of Object) Interface Configuration (see [below for nested schema](#nestedatt--interfaces))
- **provider_id** (String) Provider ID of the given router/gateway. This field can be used as connected_gateway in hpegl_vmaas_network

<a id="nestedatt--interfaces"></a>
### Nested Schema for `interfaces`

Read-Only:

- **cidr** (String)
- **id** (Number)
- **source_addresses** (String)


8 changes: 0 additions & 8 deletions docs/data-sources/vmaas_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,5 @@ data "hpegl_vmaas_template" "vanilla" {
### Optional

- **id** (String) The ID of this resource.
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **read** (String)


42 changes: 42 additions & 0 deletions docs/data-sources/vmaas_transport_zone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "hpegl_vmaas_transport_zone Data Source - terraform-provider-hpegl"
subcategory: ""
description: |-
The hpeglvmaastransportzone data source can be used to discover the ID of a hpegl vmaas transport zone.
This can then be used with resources or data sources that require a hpeglvmaastransportzone
---

# hpegl_vmaas_transport_zone (Data Source)

The hpegl_vmaas_transport_zone data source can be used to discover the ID of a hpegl vmaas transport zone.
This can then be used with resources or data sources that require a hpegl_vmaas_transport_zone

## Example Usage

```terraform
# (C) Copyright 2021 Hewlett Packard Enterprise Development LP
data "hpegl_vmaas_transport_zone" "tf_zone" {
name = "nsx_transport_zone_overlay"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **name** (String) Name of the transport zone as it appears on GLPC Portal. If there is no transport zone with this name, a 'NOT FOUND' error will returned.

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **external_id** (String)
- **internal_id** (String)
- **provider_id** (String) scope_id of the transport zone. Use the scope_id as transport zone while creating network


Loading

0 comments on commit 098a629

Please sign in to comment.