-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add docs for lcm invnetory, prechecks, status, config modules
- Loading branch information
1 parent
4b86585
commit 49d826e
Showing
7 changed files
with
252 additions
and
17 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
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
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,18 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_lcm_config_v2" | ||
sidebar_current: "docs-nutanix-datasource-lcm-config-v2" | ||
description: |- | ||
Get LCM configuration. | ||
--- | ||
|
||
# nutanix_lcm_entity_v2 | ||
Get LCM configuration. | ||
|
||
## Example | ||
|
||
```hcl | ||
data "nutanix_lcm_config_v2" "lcm-configuration" {} | ||
``` | ||
|
||
See detailed information in [Nutanix LCM Config V4] https://developers.nutanix.com/api-reference?namespace=lifecycle&version=v4.0#tag/Config/operation/getConfig |
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,34 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_lcm_status_v2" | ||
sidebar_current: "docs-nutanix-datasource-lcm-status-v2" | ||
description: |- | ||
Get the LCM framework status. | ||
--- | ||
|
||
# nutanix_lcm_status_v2 | ||
|
||
Get the LCM framework status. Represents the Status of LCM. Status represents details about a pending or ongoing action in LCM. | ||
|
||
## Example | ||
|
||
```hcl | ||
# List Prism Central | ||
data "nutanix_clusters_v2" "pc" { | ||
filter = "config/clusterFunction/any(t:t eq Clustermgmt.Config.ClusterFunctionRef'PRISM_CENTRAL')" | ||
} | ||
locals { | ||
pcExtID = data.nutanix_clusters_v2.pc.cluster_entities[0].ext_id | ||
} | ||
data "nutanix_lcm_status_v2" "lcm_framework_status" { | ||
x_cluster_id = local.pcExtID | ||
} | ||
``` | ||
|
||
# Argument Reference | ||
The following arguments are supported: | ||
|
||
* `x_cluster_id`: (Optional) Cluster uuid on which the resource is present or operation is being performed. | ||
|
||
See detailed information in [Nutanix LCM Status v4] https://developers.nutanix.com/api-reference?namespace=lifecycle&version=v4.0#tag/Status |
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,50 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_lcm_config_v2" | ||
sidebar_current: "docs-nutanix-lcm-config-v2" | ||
description: |- | ||
Update LCM configuration. | ||
--- | ||
|
||
# nutanix_lcm_entity_v2 | ||
Update LCM configuration. | ||
|
||
## Example | ||
|
||
```hcl | ||
# List Prism Central | ||
data "nutanix_clusters_v2" "pc" { | ||
filter = "config/clusterFunction/any(t:t eq Clustermgmt.Config.ClusterFunctionRef'PRISM_CENTRAL')" | ||
} | ||
locals { | ||
pcExtID = data.nutanix_clusters_v2.pc.cluster_entities[0].ext_id | ||
} | ||
# Enable Auto Inventory, Add Auto Inventory Schedule and enable auto upgrade | ||
resource "nutanix_lcm_config_v2" "lcm-configuration-update" { | ||
x_cluster_id = local.pcExtID | ||
is_auto_inventory_enabled = true | ||
auto_inventory_schedule = "16:30" | ||
has_module_auto_upgrade_enabled = true | ||
} | ||
# Update the LCM url to darksite server | ||
resource "nutanix_lcm_config_v2" "lcm-configuration-update-connectivity-type" { | ||
x_cluster_id = local.pcExtID | ||
url = "https://x.x.x.x:8000/builds" | ||
connectivity_type = "DARKSITE_WEB_SERVER" | ||
} | ||
``` | ||
## Argument Reference | ||
The following arguments are supported: | ||
|
||
* `x_cluster_id`: (Optional) Cluster uuid on which the resource is present or operation is being performed. | ||
* `url`: (Optional) URL of the LCM repository. | ||
* `is_auto_inventory_enabled`: (Optional) Indicates if the auto inventory operation is enabled. The default value is set to False. | ||
* `auto_inventory_schedule`: (Optional) The scheduled time in "%H:%M" 24-hour format of the next inventory execution. Used when auto_inventory_enabled is set to True. The default schedule time is 03:00(AM). | ||
* `connectivity_type`: (Optional)This field indicates whether LCM framework on the cluster is running in connected-site mode or darksite mode. | ||
* `is_https_enabled`: (Optional) Indicates if the LCM URL has HTTPS enabled. The default value is True. | ||
* `has_module_auto_upgrade_enabled`: (Optional) Indicates if LCM is enabled to auto-upgrade products. The default value is False. | ||
|
||
See detailed information in [Nutanix LCM Config V4] https://developers.nutanix.com/api-reference?namespace=lifecycle&version=v4.0#tag/Config/operation/updateConfig |
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: "nutanix" | ||
page_title: "NUTANIX: nutanix_lcm_perform_inventory_v2" | ||
sidebar_current: "docs-nutanix_lcm_perform_inventory_v2" | ||
description: |- | ||
Perform an inventory operation to identify/scan entities on the cluster that can be updated through LCM. | ||
--- | ||
|
||
# nutanix_lcm_perform_inventory_v2 | ||
|
||
Perform an inventory operation to identify/scan entities on the cluster that can be updated through LCM. | ||
|
||
## Example | ||
|
||
```hcl | ||
# List Prism Central | ||
data "nutanix_clusters_v2" "pc" { | ||
filter = "config/clusterFunction/any(t:t eq Clustermgmt.Config.ClusterFunctionRef'PRISM_CENTRAL')" | ||
} | ||
locals { | ||
pcExtID = data.nutanix_clusters_v2.pc.cluster_entities[0].ext_id | ||
} | ||
# perform inventory | ||
resource "nutanix_lcm_perform_inventory_v2" "inventory" { | ||
x_cluster_id = local.pcExtID | ||
} | ||
``` | ||
|
||
# Argument Reference | ||
The following arguments are supported: | ||
|
||
* `x_cluster_id`: (Optional) Cluster uuid on which the resource is present or operation is being performed. | ||
|
||
See detailed information in [Nutanix LCM Perform Inventory v4] https://developers.nutanix.com/api-reference?namespace=lifecycle&version=v4.0#tag/Inventory/operation/performInventory |
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,68 @@ | ||
--- | ||
layout: "nutanix" | ||
page_title: "NUTANIX: nutanix_lcm_prechecks_v2" | ||
sidebar_current: "docs-nutanix_lcm_prechecks_v2" | ||
description: |- | ||
Perform LCM prechecks for the intended update operation. | ||
--- | ||
|
||
# nutanix_lcm_prechecks_v2 | ||
|
||
Perform LCM prechecks for the intended update operation. | ||
|
||
## Example | ||
|
||
```hcl | ||
# List Prism Central | ||
data "nutanix_clusters_v2" "pc" { | ||
filter = "config/clusterFunction/any(t:t eq Clustermgmt.Config.ClusterFunctionRef'PRISM_CENTRAL')" | ||
} | ||
locals { | ||
pcExtID = data.nutanix_clusters_v2.pc.cluster_entities[0].ext_id | ||
} | ||
# In this example, we are trying to update Calm Policy Engine. | ||
data "nutanix_lcm_entities_v2" "lcm-entities" { | ||
filter = "entityModel eq 'Calm Policy Engine'" | ||
} | ||
data "nutanix_lcm_entity_v2" "entity-before-upgrade" { | ||
ext_id = data.nutanix_lcm_entities_v2.lcm-entities.entities[0].ext_id | ||
} | ||
resource "nutanix_lcm_prechecks_v2" "pre-checks" { | ||
x_cluster_id = local.pcExtID | ||
entity_update_specs { | ||
entity_uuid = data.nutanix_lcm_entity_v2.entity-before-upgrade.ext_id | ||
to_version = "4.0.0" | ||
} | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `x_cluster_id`: (Optional) Cluster uuid on which the resource is present or operation is being performed. | ||
* `management_server`: (Optional) Cluster management server configuration used while updating clusters with ESX or Hyper-V. | ||
* `entity_update_specs`: (Required) List of entity update objects for getting recommendations. | ||
* `skipped_precheck_flags`: (Optional) List of prechecks to skip. The allowed value is 'powerOffUvms' that skips the pinned VM prechecks. Items Enum: `POWER_OFF_UVMS` | ||
|
||
### Management Server | ||
The `management_server` attribute supports the following: | ||
|
||
* `hypervisor_type`: (Required) Type of Hypervisor present in the cluster. Enum Values: | ||
* "HYPERV" : Hyper-V Hypervisor. | ||
* "ESX" : ESX Hypervisor. | ||
* "AHV" : Nutanix AHV Hypervisor. | ||
* `ip`: (Required) IP address of the management server. | ||
* `username`: (Required) Username to login to the management server. | ||
* `password`: (Required) Password to login to the management server. | ||
|
||
### Entity Update Specs | ||
The `entity_update_specs` attribute supports the following: | ||
|
||
* `entity_uuid`: (Required) UUID of the LCM entity. | ||
* `to_version`: (Required) Version to upgrade to. | ||
|
||
See detailed information in [Nutanix LCM Prechecks v4] https://developers.nutanix.com/api-reference?namespace=lifecycle&version=v4.0#tag/Prechecks/operation/performPrechecks |