Add-RouteMap¶
Synopsis¶
Creates NSX Prefix List in the NSX Manager cluster
Syntax¶
Add-RouteMap [-server] <String> [-user] <String> [-pass] <String> [-domain] <String> [-tier0Gateway] <String>
[-routeMapName] <String> [-prefixListName] <String> [-action] <String> [-applyPolicy] <Boolean> [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description¶
The Add-RouteMap
cmdlet creates an NSX Route Map in the NSX Manager cluster.
The cmdlet connects to SDDC Manager using the -server, -user, and -password values:
- Validates that network connectivity and authentication is possible to SDDC Manager
- Validates that network connectivity and authentication is possible to NSX Manager
- Create an NSX Route Map if not already created in NSX Manager
Examples¶
Example 1¶
Add-RouteMap -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-w01 -tier0Gateway sfo-w01-ec01-t0-gw01 -routeMapName sfo-w01-ec01-t0-gw01-routemap -prefixListName sfo-w01-ec01-t0-gw01-mgmt-prefixlist -action PERMIT -applyPolicy:$true
This example creates an NSX Route Map in workload domain sfo-w01.
Parameters¶
-server¶
The fully qualified domain name of the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-user¶
The username used to authenticate to SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-pass¶
The password used to authenticate to SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-domain¶
The name of the workload domain to run against.
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.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-routeMapName¶
The NSX Route Map name to create.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-prefixListName¶
The NSX Prefix List name to create.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-action¶
The NSX Route Map action to create.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-applyPolicy¶
Specifies whether to apply the NSX Route Map to the NSX Tier0 Gateway.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
Progress Action
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
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.