chore: documentation updates (#737)

- Added documentation for `Remove-NsxtGlobalManagerStandby`. - Added documentation for `Undo-NsxtGlobalManagerStandby`. Signed-off-by: Gary Blake <gblake@vmware.com>
vmware · Sep 2, 2024 · 88ac59c · 88ac59c
1 parent 56cfa6a
commit 88ac59c
Show file tree

Hide file tree

Showing 5 changed files with 195 additions and 9 deletions.
diff --git 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
@@ -0,0 +1,63 @@
+# Remove-NsxtGlobalManagerStandby
+
+## Synopsis
+
+Deletes the standby mode configuration from the NSX Global Manager.
+
+## Syntax
+
+```powershell
+Remove-NsxtGlobalManagerStandby [-standbyServer] <String> [-displayName] <String> [<CommonParameters>]
+```
+
+## 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
@@ -0,0 +1,114 @@
+# Undo-NsxtGlobalManagerStandby
+
+## Synopsis
+
+Remove the standby mode configuration from the NSX Global Manager.
+
+## Syntax
+
+```powershell
+Undo-NsxtGlobalManagerStandby [-server] <String> [-user] <String> [-pass] <String> [-standbyServer] <String> [-standbyDisplayName] <String> [<CommonParameters>]
+```
+
+## 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
@@ -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
@@ -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