From 88ac59c82e31072cb8d0b9a9937aa72943cfde1a Mon Sep 17 00:00:00 2001 From: Gary Blake <31245616+GaryJBlake@users.noreply.github.com> Date: Mon, 2 Sep 2024 11:51:27 +0100 Subject: [PATCH] chore: documentation updates (#737) - Added documentation for `Remove-NsxtGlobalManagerStandby`. - Added documentation for `Undo-NsxtGlobalManagerStandby`. Signed-off-by: Gary Blake --- CHANGELOG.md | 18 +-- .../nsx/Remove-NsxtGlobalManagerStandby.md | 63 ++++++++++ .../nsx/Undo-NsxtGlobalManagerStandby.md | 114 ++++++++++++++++++ .../functions/solutions/fed/index.md | 7 ++ mkdocs.yml | 2 + 5 files changed, 195 insertions(+), 9 deletions(-) create mode 100644 docs/documentation/functions/nsx/Remove-NsxtGlobalManagerStandby.md create mode 100644 docs/documentation/functions/nsx/Undo-NsxtGlobalManagerStandby.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 17262d2a..0b5985d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,15 +46,15 @@ - Added `Set-NsxtTransportNode` cmdlet to apply additional configuration to a transport node. - Added `Remove-NsxtGlobalManagerStandby` cmdlet to delete the standby mode configuration from the NSX Global Manager. - Added `Undo-NsxtGlobalManagerStandby` cmdlet to remove the standby mode configuration from the NSX Global Manager. -- Added DNS entries pre-checks to the `Test-VrslcmPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-GlobalWsaPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-IlaPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-IomPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-PcaPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-PdrPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-HrmPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-CbrPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. -- Added DNS entries pre-checks to the `Test-CcmPrerequisite` cmdlet to ensure all assocated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-VrslcmPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-GlobalWsaPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-IlaPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-IomPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-PcaPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-PdrPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-HrmPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-CbrPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. +- Enhanced `Test-CcmPrerequisite` cmdlet to ensure all associated DNS entries are resolvable for both forward and reverse lookups. - Removed Alias `Request-NsxToken` from `Request-NsxtToken` cmdlet. ## v2.11.1 diff --git a/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerStandby.md b/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerStandby.md new file mode 100644 index 00000000..4fdca204 --- /dev/null +++ b/docs/documentation/functions/nsx/Remove-NsxtGlobalManagerStandby.md @@ -0,0 +1,63 @@ +# Remove-NsxtGlobalManagerStandby + +## Synopsis + +Deletes the standby mode configuration from the NSX Global Manager. + +## Syntax + +```powershell +Remove-NsxtGlobalManagerStandby [-standbyServer] [-displayName] [] +``` + +## Description + +The `Remove-NsxtGlobalManagerStandby` cmdlet deletes the standby mode configuration from the NSX Global Manager. + +## Examples + +### Example 1 + +```powershell +Remove-NsxtGlobalManagerStandby -standbyServer lax-m01-nsx-gm01.lax.rainpole.io -displayName lax-m01-nsx-gm01 +``` + +This example deletes the standby mode configuration from the NSX Global Manager. + +## Parameters + +### -standbyServer + +The fully qualified domain name of the standby NSX Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -displayName + +Display name of the standby NSX Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/documentation/functions/nsx/Undo-NsxtGlobalManagerStandby.md b/docs/documentation/functions/nsx/Undo-NsxtGlobalManagerStandby.md new file mode 100644 index 00000000..afa09976 --- /dev/null +++ b/docs/documentation/functions/nsx/Undo-NsxtGlobalManagerStandby.md @@ -0,0 +1,114 @@ +# Undo-NsxtGlobalManagerStandby + +## Synopsis + +Remove the standby mode configuration from the NSX Global Manager. + +## Syntax + +```powershell +Undo-NsxtGlobalManagerStandby [-server] [-user] [-pass] [-standbyServer] [-standbyDisplayName] [] +``` + +## DESCRIPTION + +The `Undo-NsxtGlobalManagerStandby` cmdlet removes the standby mode configuration from the NSX Global Manager. + +- Validates that network connectivity and authentication is possible to NSX Global Manager +- Removes the standby mode configuration from the NSX Global Manager + +## Examples + +### Example 1 + +```powershell +Undo-NsxtGlobalManagerStandby -server sfo-m01-nsx-gm01.sfo.rainpole.io -user admin -pass VMw@re1!VMw@re1! -standbyServer lax-m01-nsx-gm01.lax.rainpole.io -standbyDisplayName lax-m01-nsx-gm01 +``` + +This example the standby mode configuration from the NSX Global Manager. + +## Parameters + +### -server + +The fully qualified domain name of the active NSX Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -user + +The username to authenticate to the NSX active Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -pass + +The password to authenticate to the active NSX Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -standbyServer + +The fully qualified domain name of the standby NSX Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -standbyDisplayName + +Display name of the standby NSX Global Manager. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### Common Parameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/documentation/functions/solutions/fed/index.md b/docs/documentation/functions/solutions/fed/index.md index 327602a5..1f1b3f9f 100644 --- a/docs/documentation/functions/solutions/fed/index.md +++ b/docs/documentation/functions/solutions/fed/index.md @@ -14,3 +14,10 @@ Select an option for the solution Prerequisites. | ------------------------------------------------------------------------------------------------------- | --------------------- | | [`Export-NsxFederationJsonSpec`](Export-NsxFederationJsonSpec.md) | End-to-End Deployment | | [`Invoke-NsxFederationDeployment`](Invoke-NsxFederationDeployment.md) | End-to-End Deployment | + | [`Deploy-NsxtGlobalManager`](./../../nsx/Deploy-NsxtGlobalManager.md) | Procedure | + | [`Add-NsxtGlobalManagerClusterNode`](./../../nsx/Add-NsxtGlobalManagerClusterNode.md) | Procedure | + | [`Add-AntiAffinityRule`](./../../vsphere/Add-AntiAffinityRule.md) | Procedure | + | [`Add-NsxtGlobalManagerVirtualIp`](./../../nsx/Add-NsxtGlobalManagerVirtualIp.md) | Procedure | + | [`Add-NsxtRemoteTunnelEndpoint`](./../../nsx/Add-NsxtRemoteTunnelEndpoint.md) | Procedure | + | [`Add-NsxtGlobalManagerMode`](./../../nsx/Add-NsxtGlobalManagerMode.md) | Procedure | + | [`Add-NsxtGlobalManagerLocation`](./../../nsx/Add-NsxtGlobalManagerLocation.md) | Procedure | diff --git a/mkdocs.yml b/mkdocs.yml index 444e712c..963278b1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -626,6 +626,7 @@ nav: - documentation/functions/nsx/Remove-NsxtGlobalManagerClusterNode.md - documentation/functions/nsx/Remove-NsxtGlobalManagerClusterVirtualIp.md - documentation/functions/nsx/Remove-NsxtGlobalManagerLocation.md + - documentation/functions/nsx/Remove-NsxtGlobalManagerStandby.md - documentation/functions/nsx/Remove-NsxtGroup.md - documentation/functions/nsx/Remove-NsxtIpPool.md - documentation/functions/nsx/Remove-NsxtIpPoolSubnet.md @@ -663,6 +664,7 @@ nav: - documentation/functions/nsx/Test-NsxtConnection.md - documentation/functions/nsx/Test-NsxtVersionCompatibility.md - documentation/functions/nsx/Undo-NetworkSegment.md + - documentation/functions/nsx/Undo-NsxtGlobalManagerStandby.md - documentation/functions/nsx/Undo-NsxtGlobalManagerVirtualIp.md - documentation/functions/nsx/Undo-NsxtIdentitySource.md - documentation/functions/nsx/Undo-NsxtLdapRole.md