< Back
Set-NsxEdgeRouting
Post
NAME Set-NsxEdgeRouting
SYNOPSIS
Configures global routing configuration of an existing NSX Edge Services
Gateway.
SYNTAX
Set-NsxEdgeRouting [-EdgeRouting] <XmlElement> [-Confirm] [-EnableOspf] [-EnableBgp] [-RouterId <IPAddress>]
[-LocalAS <Int32>] [-EnableEcmp] [-EnableOspfRouteRedistribution] [-EnableBgpRouteRedistribution] [-EnableLogging]
[-LogLevel <String>] [-DefaultGatewayVnic <Int32>] [-DefaultGatewayMTU <Int32>] [-DefaultGatewayDescription
<String>] [-DefaultGatewayAddress <IPAddress>] [-DefaultGatewayAdminDistance <Int32>] [-Connection <PSObject>]
[<CommonParameters>]
DESCRIPTION
An NSX Edge Service Gateway provides all NSX Edge services such as firewall,
NAT, DHCP, VPN, load balancing, and high availability. Each NSX Edge virtual
appliance can have a total of ten uplink and internal network interfaces and
up to 200 subinterfaces. Multiple external IP addresses can be configured
for load balancer, site???????????????to???????????????site VPN, and NAT services.
ESGs perform ipv4 and ipv6 routing functions for connected networks and
support both static and dynamic routing via OSPF, ISIS and BGP.
The Set-NsxEdgeRouting cmdlet configures the global routing configuration of
the specified Edge Services Gateway.
PARAMETERS
-EdgeRouting <XmlElement>
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompt for confirmation. Specify as -confirm:$false to disable confirmation prompt
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-EnableOspf [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableBgp [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RouterId <IPAddress>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LocalAS <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EnableEcmp [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableOspfRouteRedistribution [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableBgpRouteRedistribution [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableLogging [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LogLevel <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayVnic <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayMTU <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayDescription <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayAddress <IPAddress>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayAdminDistance <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? named
Default value $defaultNSXConnection
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Configure the default route of the ESG
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -DefaultGatewayVnic 0 -DefaultGatewayAddress
10.0.0.101
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Enable ECMP
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableECMP
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Enable OSPF
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableOSPF -RouterId 1.1.1.1
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Enable BGP
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Get-NsxEdge | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableBGP
-RouterId 1.1.1.1 -LocalAS 1234
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableOspfRouteRedistribution:$false
-Confirm:$false
Disable OSPF Route Redistribution without confirmation.
RELATED LINKS
SYNOPSIS
Configures global routing configuration of an existing NSX Edge Services
Gateway.
SYNTAX
Set-NsxEdgeRouting [-EdgeRouting] <XmlElement> [-Confirm] [-EnableOspf] [-EnableBgp] [-RouterId <IPAddress>]
[-LocalAS <Int32>] [-EnableEcmp] [-EnableOspfRouteRedistribution] [-EnableBgpRouteRedistribution] [-EnableLogging]
[-LogLevel <String>] [-DefaultGatewayVnic <Int32>] [-DefaultGatewayMTU <Int32>] [-DefaultGatewayDescription
<String>] [-DefaultGatewayAddress <IPAddress>] [-DefaultGatewayAdminDistance <Int32>] [-Connection <PSObject>]
[<CommonParameters>]
DESCRIPTION
An NSX Edge Service Gateway provides all NSX Edge services such as firewall,
NAT, DHCP, VPN, load balancing, and high availability. Each NSX Edge virtual
appliance can have a total of ten uplink and internal network interfaces and
up to 200 subinterfaces. Multiple external IP addresses can be configured
for load balancer, site???????????????to???????????????site VPN, and NAT services.
ESGs perform ipv4 and ipv6 routing functions for connected networks and
support both static and dynamic routing via OSPF, ISIS and BGP.
The Set-NsxEdgeRouting cmdlet configures the global routing configuration of
the specified Edge Services Gateway.
PARAMETERS
-EdgeRouting <XmlElement>
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompt for confirmation. Specify as -confirm:$false to disable confirmation prompt
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-EnableOspf [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableBgp [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RouterId <IPAddress>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LocalAS <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-EnableEcmp [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableOspfRouteRedistribution [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableBgpRouteRedistribution [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableLogging [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LogLevel <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayVnic <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayMTU <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayDescription <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayAddress <IPAddress>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultGatewayAdminDistance <Int32>
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? named
Default value $defaultNSXConnection
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Configure the default route of the ESG
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -DefaultGatewayVnic 0 -DefaultGatewayAddress
10.0.0.101
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Enable ECMP
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableECMP
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Enable OSPF
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableOSPF -RouterId 1.1.1.1
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Enable BGP
PS C:\\> Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Get-NsxEdge | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableBGP
-RouterId 1.1.1.1 -LocalAS 1234
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Get-NsxEdgeRouting | Set-NsxEdgeRouting -EnableOspfRouteRedistribution:$false
-Confirm:$false
Disable OSPF Route Redistribution without confirmation.
RELATED LINKS