From 0a416d590edadbdf77f07d479420f1747d1e4c1b Mon Sep 17 00:00:00 2001 From: Haroon-Dweikat-Ntx Date: Tue, 24 Dec 2024 15:25:49 +0200 Subject: [PATCH] backup target resource and data sources docs --- website/docs/d/backup_target_v2.html.markdown | 83 +++++++++++++++++ .../docs/d/backup_targets_v2.html.markdown | 81 +++++++++++++++++ website/docs/r/backup_target_v2.html.markdown | 89 +++++++++++++++++++ 3 files changed, 253 insertions(+) create mode 100644 website/docs/d/backup_target_v2.html.markdown create mode 100644 website/docs/d/backup_targets_v2.html.markdown create mode 100644 website/docs/r/backup_target_v2.html.markdown diff --git a/website/docs/d/backup_target_v2.html.markdown b/website/docs/d/backup_target_v2.html.markdown new file mode 100644 index 000000000..ead52b212 --- /dev/null +++ b/website/docs/d/backup_target_v2.html.markdown @@ -0,0 +1,83 @@ +--- +layout: "nutanix" +page_title: "NUTANIX: nutanix_backup_target_v2 " +sidebar_current: "docs-nutanix-backup-target-v2" +description: |- + Retrieves the backup targets (cluster or object store) from a domain manager and returns the backup configuration and lastSyncTimestamp parameter to the user. + +--- + +# nutanix_backup_target_v2 + +Retrieves the backup targets (cluster or object store) from a domain manager and returns the backup configuration and lastSyncTimestamp parameter to the user. + + +## Example Usage + +```hcl + +data "nutanix_backup_target_v2" "example"{ + domain_manager_ext_id = "" + ext_id = "" +} + +``` + +## Argument Reference +The following arguments are supported: + +* `domain_manager_ext_id`: -(Required) A unique identifier for the domain manager. +* `ext_id`: -(Required) A globally unique identifier of an instance that is suitable for external consumption. + +## Attributes Reference +The following attributes are exported: + +* `tenant_id`: - A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server). +* `ext_id`: - A globally unique identifier of an instance that is suitable for external consumption. +* `links`: - A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource. +* `location`: - Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3. +* `last_sync_time`: - Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes. +* `is_backup_paused`: - Whether the backup is paused on the given cluster or not. +* `backup_pause_reason`: - Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false. + + +### Location +The location argument exports the following: + +* `cluster_location`: - A boolean value indicating whether to enable lockdown mode for a cluster. +* `object_store_location`: - Currently representing the build information to be used for the cluster creation. + +#### Cluster Location +The `cluster_location` argument exports the following: + +* `config`: - Cluster reference of the remote cluster to be connected. +* `config.ext_id`: - Cluster UUID of a remote cluster. +* `config.name`: - Name of the cluster. + +#### Object Store Location +The `object_store_location` argument exports the following: + +* `provider_config`: -(Required) The base model of S3 object store endpoint where domain manager is backed up. +* `backup_policy`: -(Optional) Backup policy for the object store provided. + +##### Provider Config +The `provider_config` argument exports the following: + +* `bucket_name`: - The bucket name of the object store endpoint where backup data of domain manager is to be stored. +* `region`: - The region name of the object store endpoint where backup data of domain manager is stored. Default is `us-east-1`. +* `credentials`: - Secret credentials model for the object store containing access key ID and secret access key. + +###### Credentials +The `credentials` argument exports the following: + +* `access_key_id`: - Access key ID for the object store provided for backup target. +* `secret_access_key`: - Secret access key for the object store provided for backup target. + +##### Backup Policy +The `backup_policy` argument exports the following: + +* `rpo_in_minutes`: - RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440. + + + +See detailed information in [Nutanix Backup Target Docs](https://developers.nutanix.com/api-reference?namespace=prism&version=v4.0#tag/DomainManager/operation/getBackupTargetById). diff --git a/website/docs/d/backup_targets_v2.html.markdown b/website/docs/d/backup_targets_v2.html.markdown new file mode 100644 index 000000000..4d2e96c40 --- /dev/null +++ b/website/docs/d/backup_targets_v2.html.markdown @@ -0,0 +1,81 @@ +--- +layout: "nutanix" +page_title: "NUTANIX: nutanix_backup_targets_v2 " +sidebar_current: "docs-nutanix-backup-targets-v2" +description: |- + Retrieves the backup targets (cluster or object store) from a domain manager and returns the backup configuration and lastSyncTimestamp parameter to the user.** + +--- + +# nutanix_backup_targets_v2 + +Lists backup targets (cluster or object store) configured for a given domain manager. + + +## Example Usage + +```hcl + +data "nutanix_backup_targets_v2" "example"{ + domain_manager_ext_id = "" +} + +``` + +## Argument Reference +The following arguments are supported: + +* `domain_manager_ext_id`: -(Required) A unique identifier for the domain manager. + +## Attributes Reference +The following attributes are exported: + +* `tenant_id`: - A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server). +* `ext_id`: - A globally unique identifier of an instance that is suitable for external consumption. +* `links`: - A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource. +* `location`: - Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3. +* `last_sync_time`: - Represents the time when the domain manager was last synchronized or copied its configuration data to the backup target. This field is updated every 30 minutes. +* `is_backup_paused`: - Whether the backup is paused on the given cluster or not. +* `backup_pause_reason`: - Specifies a reason why the backup might have paused. This will be empty if the isBackupPaused field is false. + + +### Location +The location argument exports the following: + +* `cluster_location`: - A boolean value indicating whether to enable lockdown mode for a cluster. +* `object_store_location`: - Currently representing the build information to be used for the cluster creation. + +#### Cluster Location +The `cluster_location` argument exports the following: + +* `config`: - Cluster reference of the remote cluster to be connected. +* `config.ext_id`: - Cluster UUID of a remote cluster. +* `config.name`: - Name of the cluster. + +#### Object Store Location +The `object_store_location` argument exports the following: + +* `provider_config`: -(Required) The base model of S3 object store endpoint where domain manager is backed up. +* `backup_policy`: -(Optional) Backup policy for the object store provided. + +##### Provider Config +The `provider_config` argument exports the following: + +* `bucket_name`: - The bucket name of the object store endpoint where backup data of domain manager is to be stored. +* `region`: - The region name of the object store endpoint where backup data of domain manager is stored. Default is `us-east-1`. +* `credentials`: - Secret credentials model for the object store containing access key ID and secret access key. + +###### Credentials +The `credentials` argument exports the following: + +* `access_key_id`: - Access key ID for the object store provided for backup target. +* `secret_access_key`: - Secret access key for the object store provided for backup target. + +##### Backup Policy +The `backup_policy` argument exports the following: + +* `rpo_in_minutes`: - RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440. + + + +See detailed information in [Nutanix Backup Target Docs](https://developers.nutanix.com/api-reference?namespace=prism&version=v4.0#tag/DomainManager/operation/getBackupTargetById). diff --git a/website/docs/r/backup_target_v2.html.markdown b/website/docs/r/backup_target_v2.html.markdown new file mode 100644 index 000000000..e88636440 --- /dev/null +++ b/website/docs/r/backup_target_v2.html.markdown @@ -0,0 +1,89 @@ +--- +layout: "nutanix" +page_title: "NUTANIX: nutanix_backup_target_v2 " +sidebar_current: "docs-nutanix-backup-target-v2" +description: |- + Creates a cluster or object store as the backup target. For a given Prism Central, there can be up to 3 clusters as backup targets and 1 object store as backup target. If any cluster or object store is not eligible for backup or lacks appropriate permissions, the API request will fail. For object store backup targets, specifying backup policy is mandatory along with the location of the object store. + +--- + +# nutanix_backup_target_v2 + +Create a cluster or object store as the backup target. For a given Prism Central, there can be up to 3 clusters as backup targets and 1 object store as backup target. If any cluster or object store is not eligible for backup or lacks appropriate permissions, the API request will fail. For object store backup targets, specifying backup policy is mandatory along with the location of the object store. + + +## Example Usage + +```hcl + +resource "nutanix_backup_target_v2" "example"{ + domain_manager_ext_id = "" + location { + cluster_location { + config { + ext_id = "cluster uuid" + } + } + object_store_location { + provider_config { + bucket_name = "bucket name" + region = "region" + credentials { + access_key_id = "id" + secret_access_key = "key" + } + } + backup_policy { + rpo_in_minutes = 0 + } + } + } +} + +``` + +## Argument Reference +The following arguments are supported: + +* `domain_manager_ext_id`: -(Required) A unique identifier for the domain manager. +* `location`: -(Required) Location of the backup target. For example, a cluster or an object store endpoint, such as AWS s3. + +### Location +The location argument supports the following: +> one of the following is required: +* `cluster_location`: -(Optional) A boolean value indicating whether to enable lockdown mode for a cluster. +* `object_store_location`: -(Optional) Currently representing the build information to be used for the cluster creation. + +#### Cluster Location +The `cluster_location` argument supports the following: + +* `config`: -(Required) Cluster reference of the remote cluster to be connected. +* `config.ext_id`: -(Required) Cluster UUID of a remote cluster. + +#### Object Store Location +The `object_store_location` argument supports the following: + +* `provider_config`: -(Required) The base model of S3 object store endpoint where domain manager is backed up. +* `backup_policy`: -(Optional) Backup policy for the object store provided. + +##### Provider Config +The `provider_config` argument supports the following: + +* `bucket_name`: -(Required) The bucket name of the object store endpoint where backup data of domain manager is to be stored. +* `region`: -(Optional) The region name of the object store endpoint where backup data of domain manager is stored. Default is `us-east-1`. +* `credentials`: -(Optional) Secret credentials model for the object store containing access key ID and secret access key. + +###### Credentials +The `credentials` argument supports the following: + +* `access_key_id`: -(Required) Access key ID for the object store provided for backup target. +* `secret_access_key`: -(Required) Secret access key for the object store provided for backup target. + +##### Backup Policy +The `backup_policy` argument supports the following: + +* `rpo_in_minutes`: -(Required) RPO interval in minutes at which the backup will be taken. The Value should be in the range of 60 to 1440. + + + +See detailed information in [Nutanix Backup Target Docs](https://developers.nutanix.com/api-reference?namespace=prism&version=v4.0#tag/DomainManager/operation/createBackupTarget).