diff --git a/docs/documentation/getting-started/install.md b/docs/documentation/getting-started/install.md index a7e081f..efaa0ab 100644 --- a/docs/documentation/getting-started/install.md +++ b/docs/documentation/getting-started/install.md @@ -1,71 +1,72 @@ # Installing the Module -## From Powershell Gallery +Verify that your system has a [supported edition and version](./../index.md#powershell) of PowerShell installed. -Verify that your system has a [supported edition and version](/powershell-module-for-vmware-cloud-foundation-power-management/#powershell) of PowerShell installed. +=== ":material-pipe:   Connected Environment" -Install the PowerShell [module dependencies](/powershell-module-for-vmware-cloud-foundation-power-management/#module-dependencies) from the PowerShell Gallery by running the following commands: + For environments connected to the Internet, you can install the [module dependencies](./../index.md#module-dependencies) from the PowerShell Gallery by running the following commands in the PowerShell console: -```powershell ---8<-- "./docs/snippets/install-module.ps1" -``` + ```powershell + --8<-- "./docs/snippets/install-module.ps1" + ``` -In PowerShell Core, import the modules before proceeding: + In PowerShell Core, import the modules before proceeding: -For example: + For example: -```powershell ---8<-- "./docs/snippets/import-module.ps1" -``` -## From Air-gapped Machine + ```powershell + --8<-- "./docs/snippets/import-module.ps1" + ``` -Verify that your system has a [supported edition and version](/powershell-module-for-vmware-cloud-foundation-password-management/#powershell) of PowerShell installed. +=== ":material-pipe-disconnected:   Disconnected Environment" -=== ":fontawesome-brands-windows:   Windows" + For environments disconnected from the Internet _(e.g., dark-site, air-gapped)_, you can save the [module dependencies](./../index.md#module-dependencies) from the PowerShell Gallery by running the following commands in the PowerShell console: - Save Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the PowerShell Gallery on a non air-gapped machine by running the following commands: + === ":fontawesome-brands-windows:   Windows" - ```powershell - --8<-- "./docs/snippets/save-module-local-windows.ps1" - ``` + From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console: - Copy the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the Local Machine to air-gapped facing machine by running the following commands: + ```powershell + --8<-- "./docs/snippets/save-module-local-windows.ps1" + ``` - ```powershell - --8<-- "./docs/snippets/copy-module-local-windows.ps1" - ``` + From the system with the Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console: - Import the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the air-gapped machine by running the following commands: + ```powershell + --8<-- "./docs/snippets/copy-module-local-windows.ps1" + ``` - ```powershell - --8<-- "./docs/snippets/import-module.ps1" - ``` + On the target system, import the module dependencies by running the following commands in the PowerShell console: -=== ":fontawesome-brands-linux:   Linux" + ```powershell + --8<-- "./docs/snippets/import-module.ps1" + ``` - Prerequisite for module install on Linux Machine + === ":fontawesome-brands-linux:   Linux" - ```bash - --8<-- "./docs/snippets/pre-req-linux.sh" - ``` + Prerequisite for module install on Linux Machine - Save Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the PowerShell Gallery on a non air-gapped machine by running the following commands: + ```bash + --8<-- "./docs/snippets/pre-req-linux.sh" + ``` - ```powershell - --8<-- "./docs/snippets/save-module-local-linux.ps1" - ``` + From a system with an Internet connection, save the module dependencies from the PowerShell Gallery by running the following commands in the PowerShell console: - Copy the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the Local Machine to air-gapped facing machine by running the following commands: + ```powershell + --8<-- "./docs/snippets/save-module-local-linux.ps1" + ``` - ```bash - --8<-- "./docs/snippets/copy-module-local-linux.sh" - ``` + From the system with an Internet connection, copy the module dependencies to a target system by running the following commands in the PowerShell console: - Import the PowerShell Modules [module dependencies](/powershell-module-for-vmware-cloud-foundation-password-management/#module-dependencies) from the air-gapped machine by running the following commands in PowerShell: + ```bash + --8<-- "./docs/snippets/copy-module-local-linux.sh" + ``` - ```powershell - --8<-- "./docs/snippets/import-module-local-linux.ps1" - ``` + On the target system, import the module dependencies by running the following commands in the PowerShell console: + + ```powershell + --8<-- "./docs/snippets/import-module-local-linux.ps1" + ``` Once installed, any cmdlets associated with `VMware.CloudFoundation.PowerManagement` and the its dependencies will be available for use. diff --git a/docs/index.md b/docs/index.md index d0dc0b4..e8ae048 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,14 +14,13 @@ The following table lists the supported platforms for this module. -Platform | Support -----------------------------------------------------------------------------------|------------------------------------ -:fontawesome-solid-cloud:   VMware Cloud Foundation 5.1.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 5.0.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 4.5.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 4.4.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 4.3.x on vSAN ReadyNodes | :fontawesome-solid-check:{ .green } -:fontawesome-solid-cloud:   VMware Cloud Foundation 5.0.x on Dell VxRail | :fontawesome-solid-check:{ .green } +Platform | vSAN ReadyNodes | Dell VxRail +-------------------------------------------------------------|-------------------------------------|------------------------------------ +:fontawesome-solid-cloud:   VMware Cloud Foundation 5.1 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-x:{ .red } +:fontawesome-solid-cloud:   VMware Cloud Foundation 5.0 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-check:{ .green } +:fontawesome-solid-cloud:   VMware Cloud Foundation 4.5 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-x:{ .red } +:fontawesome-solid-cloud:   VMware Cloud Foundation 4.4 | :fontawesome-solid-check:{ .green } | :fontawesome-solid-x:{ .red } +:fontawesome-solid-cloud:   VMware Cloud Foundation 4.3 | :fontawesome-solid-x:{ .red } | :fontawesome-solid-x:{ .red } !!! note diff --git a/mkdocs.yml b/mkdocs.yml index 80366b6..beb8a61 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,7 @@ edit_uri: blob/main/docs/ # Copyright copyright: | - Copyright © 2005-2023 Broadcom. All Rights Reserved.
+ Copyright © 2005-2024 Broadcom. All Rights Reserved.
The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

# Configuration @@ -96,8 +96,8 @@ markdown_extensions: - attr_list - md_in_html - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg options: custom_icons: - material/.icons @@ -134,7 +134,7 @@ nav: - License: license.md - Reference: - documentation/index.md - - Cmdlets: + - Functions: - Get-DrsAutomationLevel: documentation/functions/Get-DrsAutomationLevel.md - Get-EdgeNodeFromNSXManager: documentation/functions/Get-EdgeNodeFromNSXManager.md - Get-MaintenanceMode: documentation/functions/Get-MaintenanceMode.md @@ -147,6 +147,7 @@ nav: - Get-VMsWithPowerStatus: documentation/functions/Get-VMsWithPowerStatus.md - Get-VMToClusterMapping: documentation/functions/Get-VMToClusterMapping.md - Invoke-EsxCommand: documentation/functions/Invoke-EsxCommand.md + - Invoke-VxrailClusterShutdown: documentation/functions/Invoke-VxrailClusterShutdown.md - Set-DrsAutomationLevel: documentation/functions/Set-DrsAutomationLevel.md - Set-MaintenanceMode: documentation/functions/Set-MaintenanceMode.md - Set-Retreatmode: documentation/functions/Set-Retreatmode.md