feat: add location to end-to-end (#733)

- Enhanced `Export-NsxFederationJsonSpec` to support adding a local manager. - Enhanced `Invoke-NsxFederationDeployment` cmdlet with `Add-NsxtGlobalManagerLocation`. - Added `Add-NsxtGlobalManagerLocation` cmdlet to support adding an NSX Local Manager to an NSX Global Manager. - Added `Get-NsxtGlobalManagerOnBoarding` cmdlet to retrieve location information configured in NSX Global Manager. - Added `Start-NsxtBackup` cmdlet to trigger a backup of the NSX Manager. - Added `Get-NsxtGlobalManagerBackupOverview` cmdlet to retrieve the backup history for an NSX Local Manager instance via the NSX Global Manager. - Added `Get-NsxtTransportNode` cmdlet to retrieve the transport node details from NSX Manager. - Added `Set-NsxtTransportNode` cmdlet to apply additional configuration to a transport node. - Added `Set-NsxtTransportNode` cmdlet to apply additional configuration to a transport node. - All documentation. Signed-off-by: Gary Blake <[email protected]>
vmware · Aug 23, 2024 · 4e60106 · 4e60106
1 parent cd4e23a
commit 4e60106
Show file tree

Hide file tree

Showing 10 changed files with 825 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -37,6 +37,13 @@
 - Added `Set-NsxtGloblaManagerStandby` cmdlet to set the NSX Global Manager to standby mode.
 - Added `Test-NsxtVersionCompatibility` cmdlet to check the NSX version compatibility between NSX Managers.
 - Added `Add-NsxtGlobalManagerMode` cmdlet to configure the NSX Global Manager to Active or Standby mode.
+- Added `Add-NsxtGlobalManagerLocation` cmdlet to support adding an NSX Local Manager to an NSX Global Manager.
+- Added `Get-NsxtGlobalManagerOnBoarding` cmdlet to retrieve location information configured in NSX Global Manager.
+- Added `Start-NsxtGlobalManagerOnBoarding` cmdlet to import the NSX Local Manager objects into the NSX Global Manager
+- Added `Start-NsxtBackup` cmdlet to trigger a backup of the NSX Manager.
+- Added `Get-NsxtGlobalManagerBackupOverview` cmdlet to retrieve the backup history for an NSX Local Manager instance via the NSX Global Manager.
+- Added `Get-NsxtTransportNode` cmdlet to retrieve the transport node details from NSX Manager.
+- Added `Set-NsxtTransportNode` cmdlet to apply additional configuration to a transport node.
 - Removed Alias `Request-NsxToken` from `Request-NsxtToken` cmdlet.
 
 ## v2.11.1

diff --git a/PowerValidatedSolutions.psd1 b/PowerValidatedSolutions.psd1
diff --git a/PowerValidatedSolutions.psm1 b/PowerValidatedSolutions.psm1
diff --git a/docs/documentation/functions/nsx/Add-NsxtGlobalManagerLocation.md b/docs/documentation/functions/nsx/Add-NsxtGlobalManagerLocation.md
@@ -0,0 +1,178 @@
+# Add-NsxtGlobalManagerLocation
+
+## Synopsis
+
+Configures an NSX Local Manager in NSX Global Manager.
+
+## Syntax
+
+```powershell
+Add-NsxtGlobalManagerLocation [-server] <String> [-user] <String> [-pass] <String> [-globalManager] <String> [-location] <String> [-localManagerFqdn] <String> [-localManagerUser] <String> [-localManagerPass] <String> [-edgeNodes] <Array> [<CommonParameters>]
+```
+
+## Description
+
+The `Add-NsxtGlobalManagerLocation` cmdlet configures an NSX Local Manager in NSX Global Manager.
+
+- Validates that network connectivity and authentication is possible to NSX Global Manager
+- Adds and configures the NSX Local Manager in the NSX Global Manager
+
+## Examples
+
+### Example 1
+
+```powershell
+Add-NsxtGlobalManagerLocation -server sfo-m01-nsx-gm01.sfo.rainpole.io -user admin -pass VMw@re1!VMw@re1! -globalManager sfo-m01-nsx-gm01.sfo.rainpole.io -location sfo-m01 -localManagerFqdn sfo-m01-nsx01.sfo.rainpole.io -localManagerUser admin -localManagerPass VMw@re1!VMw@re1! -edgeNodes @("sfo-m01-r01-en01","sfo-m01-r01-en02")
+```
+
+This example adds the NSX Local Manager to to 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
+```
+
+### -globalManager
+
+The display name of the 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
+```
+
+### -location
+
+The location name for the NSX Local Manager.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 5
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -localManagerFqdn
+
+The fully qualified domain name of the NSX Local Manager.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 6
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -localManagerUser
+
+The password to authenticate to the standby NSX Local Manager.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 7
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -localManagerPass
+
+The password to authenticate to the standby NSX Local Manager.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 8
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -edgeNodes
+
+An array of the NSX Edge nodes to be configured.
+
+```yaml
+Type: Array
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 9
+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/Get-NsxtGlobalManagerBackupOverview.md b/docs/documentation/functions/nsx/Get-NsxtGlobalManagerBackupOverview.md
@@ -0,0 +1,47 @@
+# Get-NsxtGlobalManagerBackupOverview
+
+## Synopsis
+
+Return the backup history for an NSX Local Manager instance.
+
+## SYNTAX
+
+```powershell
+Get-NsxtGlobalManagerBackupOverview [-siteId] <String> [<CommonParameters>]
+```
+
+## Description
+
+The `Get-NsxtGlobalManagerBackupOverview` cmdlet returns the backup history for an NSX Local Manager instance.
+
+## Examples
+
+### Example 1
+
+```powershell
+Get-NsxtGlobalManagerBackupOverview -siteId sfo-w01-nsx01.sfo.rainpole.io
+```
+
+This example returns the backup history for a NSX Local Manager instance based on the site ID.
+
+## Parameters
+
+### -siteId
+
+The siteId of the NSX Local Manager.
+
+```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).
diff --git a/docs/documentation/functions/nsx/Get-NsxtGlobalManagerOnBoarding.md b/docs/documentation/functions/nsx/Get-NsxtGlobalManagerOnBoarding.md
@@ -0,0 +1,72 @@
+# Get-NsxtGlobalManagerOnBoarding
+
+## Synopsis
+
+Retrieve the locations configured in NSX Global Manager.
+
+## Syntax
+
+```powershell
+Get-NsxtGlobalManagerOnBoarding [-location] <String> [-action] <String> [<CommonParameters>]
+```
+
+## Description
+
+The `Get-NsxtGlobalManagerOnBoarding` cmdlet retrieves the locations configured in an NSX Global Manager.
+
+## Examples
+
+### Example 1
+
+```powershell
+Get-NsxtGlobalManagerOnBoarding -location sfo-m01 -action conflict
+```
+
+This example checks that the location sfo-m01 does not have any conflicts.
+
+### Example 2
+
+```powershell
+Get-NsxtGlobalManagerOnBoarding -location sfo-m01 -action status
+```
+
+This example checks the status of the location sfo-m01.
+
+## Parameters
+
+### -location
+
+The name of the location.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -action
+
+Check for conflicts.
+(Can be one of 'conflict' or 'action')
+
+```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/Set-NsxtTransportNode.md b/docs/documentation/functions/nsx/Set-NsxtTransportNode.md
@@ -0,0 +1,63 @@
+# Set-NsxtTransportNode
+
+## Synopsis
+
+Apply configuration to a transport node.
+
+## Syntax
+
+```powershell
+Set-NsxtTransportNode [-transportNodeId] <String> [-jsonBody] <String> [<CommonParameters>]
+```
+
+## Description
+
+The `Set-NsxtTransportNode` cmdlet applies configuration to a transport node in NSX Manager.
+
+## Examples
+
+### Example 1
+
+```powershell
+Set-NsxtTransportNode -transportNodeId 7740f2da-83b5-40de-bc4c-665ea779bbd0 -jsonBody $jsonBody
+```
+
+This example applies configuration to a transport node in NSX Manager.
+
+## Parameters
+
+### -transportNodeId
+
+The id of the transport node.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -jsonBody
+
+The JSON payload for the configuration to be applied.
+
+```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).