chore: documentation updates (#746)

- Added `Import-NsxtGlobalManagerLocation` cmdlet to import NSX Local Manager objects into NSX Global Manager.
- Added missing documentation.

Signed-off-by: Gary Blake <gblake@vmware.com>

CHANGELOG.md

@@ -50,17 +50,7 @@
 - Added `Test-NsxFederationPrerequisite` cmdlet to verify the platform before attempting the deployment of NSX Federation.
 - Added `Request-NsxFederationMscaSignedCertificate` cmdlet to request Microsoft CA Signed certificates for the NSX Global Managers.
 - Added `Start-NsxFederationMenu` cmdlet to enable NSX Federation automation.
-- 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.
-- Enhanced `Test-PdrPrerequisite` cmdlet to verify that NSX Federation is configured in the environment.
-- Removed Alias `Request-NsxToken` from `Request-NsxtToken` cmdlet.
+- Added `Import-NsxtGlobalManagerLocation` cmdlet to import NSX Local Manager objects into NSX Global Manager.
 - Added `Get-NsxtGlobalManagerTier0Gateway` cmdlet to retrieve a list of Tier-0 gateways from the NSX Global Manager.
 - Added `Get-NsxtGlobalManagerTier1Gateway` cmdlet to retrieve a list of Tier-1 gateways from the NSX Global Manager.
 - Added `Get-NsxtGlobalManagerEdgeClusters` cmdlet to retrieve the NSX Edge cluster information for the specified site.
@@ -74,6 +64,17 @@
 - Added `Get-NsxtGlobalManagerSegment` cmdlet to retrieve the list of configured segments from the NSX Global Manager.
 - Added `Set-NsxtGlobalManagerSegment` cmdlet to apply the configuration to the NSX Global Manager segment.
 - Added `Update-NsxtGlobalManagerSegment` cmdlet to update the NSX segment in the NSX Global Manager instance.
+- 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.
+- Enhanced `Test-PdrPrerequisite` cmdlet to verify that NSX Federation is configured in the environment.
+- Removed Alias `Request-NsxToken` from `Request-NsxtToken` cmdlet.
 
 ## v2.11.1
 

docs/documentation/functions/nsx/Add-NsxtGlobalManagerTier1Gateway.md

@@ -0,0 +1,132 @@
+# Add-NsxtGlobalManagerTier1Gateway
+
+## Synopsis
+
+Create a Tier 1 Gateway on the NSX Global Manager.
+
+## Syntax
+
+```powershell
+Add-NsxtGlobalManagerTier1Gateway [-server] <String> [-user] <String> [-pass] <String> [-tier1Gateway] <String> [-tier0Gateway] <String> [-location] <String> [<CommonParameters>]
+```
+
+## Description
+
+The `Add-NsxtGlobalManagerTier1Gateway` cmdlet creates a Tier 1 Gateway on the NSX Global Manager.
+
+- Validates that network connectivity and authentication are possible to NSX Global Manager.
+- Validates that the given tier 0 gateway and location exist in the NSX Global Manager.
+- Creates a Tier 1 Gateway on the NSX Global Manager.
+- Creates the locale service on Tier 1 Gateway.
+
+## Examples
+
+### Example 1
+
+```powershell
+Add-NsxtGlobalManagerTier1Gateway -server sfo-m01-nsx-gm01.sfo.rainpole.io -user admin -pass VMw@re1!VMw@re1! -tier1Gateway xint-m01-ec01-t1-gw01 -tier0Gateway sfo-m01-ec01-t0-gw01 -location sfo-m01
+```
+
+This example creates a Tier 1 Gateway on the NSX Global Manager.
+
+## Parameters
+
+### -server
+
+The fully qualified domain name of the 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 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 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
+```
+
+### -tier1Gateway
+
+The NSX Tier1 Gateway name to create.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 4
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -tier0Gateway
+
+The NSX Tier0 Gateway to connect to.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 5
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -location
+
+The name of the location.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 6
+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).

docs/documentation/functions/nsx/Get-NsxtGlobalManagerEdgeCluster.md

@@ -0,0 +1,47 @@
+# Get-NsxtGlobalManagerEdgeCluster
+
+## Synopsis
+
+Retrieve the NSX Edge cluster information for the specified site.
+
+## Syntax
+
+```powershell
+Get-NsxtGlobalManagerEdgeCluster [-siteId] <String> [<CommonParameters>]
+```
+
+## Description
+
+The `Get-NsxtGlobalManagerEdgeCluster` cmdlet retrieves the NSX Edge cluster information for the specified site.
+
+## Examples
+
+### Example 1
+
+```powershell
+Get-NsxtGlobalManagerEdgeCluster -siteId sfo-m01
+```
+
+This example retrieves the NSX Edge cluster information for the specified site.
+
+## PARAMETERS
+
+### -siteId
+
+The ID of the site.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+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).

docs/documentation/functions/nsx/Get-NsxtGlobalManagerSegment.md

@@ -0,0 +1,55 @@
+# Get-NsxtGlobalManagerSegment
+
+## Synopsis
+
+Retrieve the list of configured segments from the NSX Global Manager.
+
+## Syntax
+
+```powershell
+Get-NsxtGlobalManagerSegment [[-segmentId] <String>] [<CommonParameters>]
+```
+
+## Description
+
+The `Get-NsxtGlobalManagerSegment` cmdlet retrieves the list of configured segments from the NSX Global Manager.
+
+## Examples
+
+### Example 1
+
+```powershell
+Get-NsxtGlobalManagerSegment
+```
+
+This example retrieves the list of configured segments from the NSX Global Manager.
+
+### Example 2
+
+```powershell
+Get-NsxtGlobalManagerSegment -segmentId "799a0af5-d89b-437b-836f-61361e114f6e"
+```
+
+This example retrieves a configured segment from the NSX Global Manager.
+
+## Parameters
+
+### -segmentId
+
+The ID of the segment in the NSX Global Manager.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+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).

docs/documentation/functions/nsx/Get-NsxtGlobalManagerTier0Gateway.md

@@ -0,0 +1,55 @@
+# Get-NsxtGlobalManagerTier0Gateway
+
+## Synopsis
+
+Retrieve a list of Tier-0 gateways from the NSX Global Manager.
+
+## Syntax
+
+```powershell
+Get-NsxtGlobalManagerTier0Gateway [[-id] <String>] [<CommonParameters>]
+```
+
+## Description
+
+The `Get-NsxtGlobalManagerTier0Gateway` cmdlet retrieves a list of Tier-0 gateways from the NSX Global Manager.
+
+## Examples
+
+### Example 1
+
+```powershell
+Get-NsxtGlobalManagerTier0Gateway 
+```
+
+This example retrieves a list of Tier-0 gateways from the NSX Global Manager.
+
+### Example 2
+
+```powershell
+Get-NsxtGlobalManagerTier0Gateway -id "92a3a3b4-a1d1-48a9-8190-dca8e44c18c1"
+```
+
+This example retrieves a list of Tier-0 gateways from the NSX Global Manager.
+
+## Parameters
+
+### -id
+
+The ID of the Tier-0 Gateway.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+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).

docs/documentation/functions/nsx/Get-NsxtGlobalManagerTier1Gateway.md

@@ -0,0 +1,55 @@
+# Get-NsxtGlobalManagerTier1Gateway
+
+## Synopsis
+
+Retrieve a list of Tier-1 gateways from the NSX Global Manager.
+
+## Syntax
+
+```powershell
+Get-NsxtGlobalManagerTier1Gateway [[-id] <String>] [<CommonParameters>]
+```
+
+## Description
+
+The `Get-NsxtGlobalManagerTier1Gateway` cmdlet retrieves a list of Tier-1 gateways from the NSX Global Manager.
+
+## Examples
+
+### Example 1
+
+```powershell
+Get-NsxtGlobalManagerTier1Gateway 
+```
+
+This example retrieves a list of Tier-1 gateways from the NSX Global Manager.
+
+### Example 2
+
+```powershell
+Get-NsxtGlobalManagerTier1Gateway -id xint-m01-ec01-t1-gw01
+```
+
+This example retrieves a list of Tier-1 gateways from the NSX Global Manager.
+
+## Parameters
+
+### -id
+
+The ID of the Tier-1 Gateway.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+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).