-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Connect Additional Instances to Cross-Instance Tier-0 Gateway (#…
…757) - Updated `Invoke-NsxFederationDeployment` with `Undo-NsxtGlobalManagerTier0Gateway` procedure. - Added Documentation. Signed-off-by: Gary Blake <gblake@vmware.com>
- Loading branch information
1 parent
ad604d2
commit 925e7ab
Showing
8 changed files
with
544 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
docs/documentation/functions/nsx/Export-NsxtGlobalManagerTier0GatewayConfig.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
# Export-NsxtGlobalManagerTier0GatewayConfig | ||
|
||
## Synopsis | ||
|
||
Create the JSON specification file for the BGP neighbor and interface configuration. | ||
|
||
## Syntax | ||
|
||
```powershell | ||
Export-NsxtGlobalManagerTier0GatewayConfig [-server] <String> [-user] <String> [-pass] <String> [-tier0Gateway] <String> [-location] <String> [-bgpNeighborJsonFile] <String> [-interfaceJsonFile] <String> [<CommonParameters>] | ||
``` | ||
|
||
## Description | ||
|
||
The `Export-NsxtGlobalManagerTier0GatewayConfig` cmdlet removes the Tier 0 Gateway from the NSX Global Manager. | ||
|
||
- Validates that network connectivity and authentication is possible to NSX Global Manager. | ||
- Creates the JSON specification file for the BGP neighbor and interface configuration, if configured. | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
```powershell | ||
Export-NsxtGlobalManagerTier0GatewayConfig -server sfo-m01-nsx-gm01.sfo.rainpole.io -user admin -pass VMw@re1!VMw@re1! -tier0Gateway lax-m01-ec01-t0-gw01 -location lax-m01 -bgpNeighborJsonFile ./tier0-bgp-neighbor.json -interfaceJsonFile ./tier0-interface.json | ||
``` | ||
|
||
This example creates the JSON specification file for the BGP neighbor and interface configuration. | ||
|
||
## 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 | ||
``` | ||
### -tier0Gateway | ||
The NSX Tier0 Gateway name to delete. | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 4 | ||
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: 5 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -bgpNeighborJsonFile | ||
The JSON file to be used for exporting the BGP neighbor configuration | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 6 | ||
Default value: None | ||
Accept pipeline input: False | ||
Accept wildcard characters: False | ||
``` | ||
### -interfaceJsonFile | ||
The JSON file to be used for exporting the interface configuration | ||
```yaml | ||
Type: String | ||
Parameter Sets: (All) | ||
Aliases: | ||
|
||
Required: True | ||
Position: 7 | ||
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). |
Oops, something went wrong.