Skip to content

Commit

Permalink
Merge pull request #96 from dell/doc-update
Browse files Browse the repository at this point in the history
doc-updates
  • Loading branch information
Sakshi-dell authored Oct 26, 2023
2 parents 7decc54 + 702ce67 commit 61fb459
Show file tree
Hide file tree
Showing 51 changed files with 341 additions and 97 deletions.
7 changes: 4 additions & 3 deletions docs/data-sources/host.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ linkTitle: "powerstore_host"
page_title: "powerstore_host Data Source - powerstore"
subcategory: ""
description: |-
Host DataSource
This datasource is used to query the existing host from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_host (Data Source)

Host DataSource
This datasource is used to query the existing host from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

~> **Note:** Only one of `name` or `id` can be provided at a time.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +62,7 @@ output "hostResult" {
value = data.powerstore_host.test1.hosts
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_host.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
7 changes: 4 additions & 3 deletions docs/data-sources/hostgroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ linkTitle: "powerstore_hostgroup"
page_title: "powerstore_hostgroup Data Source - powerstore"
subcategory: ""
description: |-
HostGroup DataSource.
This datasource is used to query the existing host group from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_hostgroup (Data Source)

HostGroup DataSource.
This datasource is used to query the existing host group from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

~> **Note:** Only one of `name` or `id` can be provided at a time.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +62,7 @@ output "hostGroupResult" {
value = data.powerstore_hostgroup.test1.host_groups
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_hostgroup.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
7 changes: 4 additions & 3 deletions docs/data-sources/protectionpolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ linkTitle: "powerstore_protectionpolicy"
page_title: "powerstore_protectionpolicy Data Source - powerstore"
subcategory: ""
description: |-
ProtectionPolicy DataSource.
This datasource is used to query the existing protection policy from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_protectionpolicy (Data Source)

ProtectionPolicy DataSource.
This datasource is used to query the existing protection policy from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

~> **Note:** Only one of `name` or `id` can be provided at a time.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +62,7 @@ output "policyResult" {
value = data.powerstore_protectionpolicy.test1.policies
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_protectionpolicy.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/snapshotrule.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ linkTitle: "powerstore_snapshotrule"
page_title: "powerstore_snapshotrule Data Source - powerstore"
subcategory: ""
description: |-
SnapshotRule DataSource
This datasource is used to query the existing snapshot rule from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_snapshotrule (Data Source)

SnapshotRule DataSource

~> **Note:** Only one of `name` or `id` can be provided at a time.
This datasource is used to query the existing snapshot rule from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +61,7 @@ output "snapshotRule" {
value = data.powerstore_snapshotrule.test1.snapshot_rules
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_snapshotrule.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ linkTitle: "powerstore_volume"
page_title: "powerstore_volume Data Source - powerstore"
subcategory: ""
description: |-
Volume DataSource.
This datasource is used to query the existing volume from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_volume (Data Source)

Volume DataSource.

~> **Note:** Only one of `name` or `id` can be provided at a time.
This datasource is used to query the existing volume from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +61,7 @@ output "volumeResult" {
value = data.powerstore_volume.test1.volumes
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_volume.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/volume_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ linkTitle: "powerstore_volume_snapshot"
page_title: "powerstore_volume_snapshot Data Source - powerstore"
subcategory: ""
description: |-
VolumeSnapshot DataSource.
This datasource is used to query the existing volume snapshot from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_volume_snapshot (Data Source)

VolumeSnapshot DataSource.

~> **Note:** Only one of `name` or `id` can be provided at a time.
This datasource is used to query the existing volume snapshot from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -63,6 +62,7 @@ output "volumeSnapshotResult" {
value = data.powerstore_volume_snapshot.test1.volumes
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_volume_snapshot.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
7 changes: 4 additions & 3 deletions docs/data-sources/volumegroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ linkTitle: "powerstore_volumegroup"
page_title: "powerstore_volumegroup Data Source - powerstore"
subcategory: ""
description: |-
VolumeGroup DataSource.
This datasource is used to query the existing volumegroup from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_volumegroup (Data Source)

VolumeGroup DataSource.
This datasource is used to query the existing volumegroup from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

~> **Note:** Only one of `name` or `id` can be provided at a time.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +62,7 @@ output "volumeGroupResult" {
value = data.powerstore_volumegroup.test1.volume_groups
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_volumegroup.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
7 changes: 4 additions & 3 deletions docs/data-sources/volumegroup_snapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ linkTitle: "powerstore_volumegroup_snapshot"
page_title: "powerstore_volumegroup_snapshot Data Source - powerstore"
subcategory: ""
description: |-
VolumeGroup Snapshot DataSource.
This datasource is used to query the existing volumegroup snapshot from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.
---

# powerstore_volumegroup_snapshot (Data Source)

VolumeGroup Snapshot DataSource.
This datasource is used to query the existing volumegroup snapshot from PowerStore array. The information fetched from this datasource can be used for getting the details for further processing in resource block.

~> **Note:** Only one of `name` or `id` can be provided at a time.
> **Note:** Only one of `name` or `id` can be provided at a time.
## Example Usage

Expand Down Expand Up @@ -62,6 +62,7 @@ output "volumeGroupSnapshotResult" {
value = data.powerstore_volumegroup_snapshot.test1.volume_groups
}
```
After the successful execution of above said block, We can see the output by executing `terraform output` command. Also, we can fetch information via the variable: `data.powerstore_volumegroup_snapshot.test1.attribute_name` where attribute_name is the attribute which user wants to fetch.

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
6 changes: 4 additions & 2 deletions docs/resources/host.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ linkTitle: "powerstore_host"
page_title: "powerstore_host Resource - powerstore"
subcategory: ""
description: |-
Host resource
This resource is used to manage the host entity of PowerStore Array. We can Create, Update and Delete the host using this resource. We can also import an existing host from PowerStore array.
---

# powerstore_host (Resource)

Host resource
This resource is used to manage the host entity of PowerStore Array. We can Create, Update and Delete the host using this resource. We can also import an existing host from PowerStore array.

~> **Note:** `name`, `os_type` and `initiators` are the required attributes to create.
~> **Note:** `os_type` cannot be updated.
Expand Down Expand Up @@ -70,6 +70,8 @@ resource "powerstore_host" "test" {
}
```

After the execution of above resource block, host would have been created on the PowerStore array. For more information, Please check the terraform state file.

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

Expand Down
6 changes: 4 additions & 2 deletions docs/resources/hostgroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ linkTitle: "powerstore_hostgroup"
page_title: "powerstore_hostgroup Resource - powerstore"
subcategory: ""
description: |-
HostGroup resource
This resource is used to manage the host group entity of PowerStore Array. We can Create, Update and Delete the host group using this resource. We can also import an existing host group from PowerStore array.
---

# powerstore_hostgroup (Resource)

HostGroup resource
This resource is used to manage the host group entity of PowerStore Array. We can Create, Update and Delete the host group using this resource. We can also import an existing host group from PowerStore array.

~> **Note:** Exactly one of `host_ids` and `host_names` is required.
~> **Note:** `host_connectivity` cannot be used while creating host group resource but it can be used while updating the host group resource.
Expand Down Expand Up @@ -64,6 +64,8 @@ resource "powerstore_hostgroup" "test" {
}
```

After the execution of above resource block, host group would have been created on the PowerStore array. For more information, Please check the terraform state file.

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

Expand Down
9 changes: 5 additions & 4 deletions docs/resources/protectionpolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ linkTitle: "powerstore_protectionpolicy"
page_title: "powerstore_protectionpolicy Resource - powerstore"
subcategory: ""
description: |-
ProtectionPolicy resource
This resource is used to manage the protection policy entity of PowerStore Array. We can Create, Update and Delete the protection policy using this resource. We can also import an existing protection policy from PowerStore array.
---

# powerstore_protectionpolicy (Resource)

ProtectionPolicy resource

This resource is used to manage the protection policy entity of PowerStore Array. We can Create, Update and Delete the protection policy using this resource. We can also import an existing protection policy from PowerStore array.

## Example Usage

Expand Down Expand Up @@ -62,6 +61,8 @@ resource "powerstore_protectionpolicy" "terraform-provider-test1" {
}
```

After the execution of above resource block, protection policy would have been created on the PowerStore array. For more information, Please check the terraform state file.

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

Expand Down Expand Up @@ -114,4 +115,4 @@ Import is supported using the following syntax:
# }
# Step 4 - Execute the command: terraform import "powerstore_protectionpolicy.resource_block_name" "id_of_the_protection_policy" (resource_block_name must be taken from step 3 and id must be taken from step 2)
# Step 5 - After successful execution of the command , check the state file
```
```
9 changes: 5 additions & 4 deletions docs/resources/snapshotrule.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ linkTitle: "powerstore_snapshotrule"
page_title: "powerstore_snapshotrule Resource - powerstore"
subcategory: ""
description: |-
SnapshotRule resource
This resource is used to manage the snapshot rule entity of PowerStore Array. We can Create, Update and Delete the snapshot rule using this resource. We can also import an existing snapshot rule from PowerStore array.
---

# powerstore_snapshotrule (Resource)

SnapshotRule resource

This resource is used to manage the snapshot rule entity of PowerStore Array. We can Create, Update and Delete the snapshot rule using this resource. We can also import an existing snapshot rule from PowerStore array.

## Example Usage

Expand Down Expand Up @@ -71,6 +70,8 @@ resource "powerstore_snapshotrule" "test1" {
}*/
```

After the execution of above resource block snapshot rule would have been created on the PowerStore array. For more information, Please check the terraform state file.

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

Expand Down Expand Up @@ -127,4 +128,4 @@ Import is supported using the following syntax:
# }
# Step 4 - Execute the command: terraform import "powerstore_snapshotrule.resource_block_name" "id_of_the_snapshot_rule" (resource_block_name must be taken from step 3 and id must be taken from step 2)
# Step 5 - After successful execution of the command , check the state file
```
```
9 changes: 5 additions & 4 deletions docs/resources/storagecontainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ linkTitle: "powerstore_storagecontainer"
page_title: "powerstore_storagecontainer Resource - powerstore"
subcategory: ""
description: |-
StorageContainer resource
This resource is used to manage the storage container entity of PowerStore Array. We can Create, Update and Delete the storage container using this resource. We can also import an existing storage container from PowerStore array.
---

# powerstore_storagecontainer (Resource)

StorageContainer resource

This resource is used to manage the storage container entity of PowerStore Array. We can Create, Update and Delete the storage container using this resource. We can also import an existing storage container from PowerStore array.

## Example Usage

Expand Down Expand Up @@ -62,6 +61,8 @@ resource "powerstore_storagecontainer" "test1" {
}
```

After the execution of above resource block, storage container container would have been created on the PowerStore array. For more information, Please check the terraform state file.

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

Expand Down Expand Up @@ -94,4 +95,4 @@ Import is supported using the following syntax:
# }
# Step 4 - Execute the command: terraform import "powerstore_storagecontainer.resource_block_name" "id_of_the_storage_container" (resource_block_name must be taken from step 3 and id must be taken from step 2)
# Step 5 - After successful execution of the command , check the state file
```
```
9 changes: 5 additions & 4 deletions docs/resources/volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ linkTitle: "powerstore_volume"
page_title: "powerstore_volume Resource - powerstore"
subcategory: ""
description: |-
Volume Resource.
This resource is used to manage the volume entity of PowerStore Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from PowerStore array.
---

# powerstore_volume (Resource)

Volume Resource.

This resource is used to manage the volume entity of PowerStore Array. We can Create, Update and Delete the volume using this resource. We can also import an existing volume from PowerStore array.

## Example Usage

Expand Down Expand Up @@ -72,6 +71,8 @@ resource "powerstore_volume" "test1" {
}
```

After the execution of above resource block, volume would have been created on the PowerStore array. For more information, Please check the terraform state file.

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

Expand Down Expand Up @@ -145,4 +146,4 @@ Import is supported using the following syntax:
# }
# Step 4 - Execute the command: terraform import "powerstore_volume.resource_block_name" "id_of_the_volume" (resource_block_name must be taken from step 3 and id must be taken from step 2)
# Step 5 - After successful execution of the command , check the state file
```
```
Loading

0 comments on commit 61fb459

Please sign in to comment.