< Back
Set-NsxLogicalRouterRouting
Post
NAME Set-NsxLogicalRouterRouting
SYNOPSIS
Configures global routing configuration of an existing NSX Logical Router
SYNTAX
Set-NsxLogicalRouterRouting [-LogicalRouterRouting] <XmlElement> [-Confirm] [-EnableOspf] [-ProtocolAddress
<IPAddress>] [-ForwardingAddress <IPAddress>] [-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 Logical Router is a distributed routing function implemented within
the ESXi kernel, and optimised for east west routing.
Logical Routers perform ipv4 and ipv6 routing functions for connected
networks and support both static and dynamic routing via OSPF and BGP.
The Set-NsxLogicalRouterRouting cmdlet configures the global routing
configuration of the specified LogicalRouter.
PARAMETERS
-LogicalRouterRouting <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
-ProtocolAddress <IPAddress>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ForwardingAddress <IPAddress>
Required? false
Position? named
Default value
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:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting -DefaultGatewayVnic 0
-DefaultGatewayAddress 10.0.0.101
Configure the default route of the LogicalRouter.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting -EnableECMP
Enable ECMP
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting -EnableOSPF -RouterId
1.1.1.1 -ForwardingAddress 1.1.1.1 -ProtocolAddress 1.1.1.2
Enable OSPF
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting |
Set-NsxLogicalRouterRouting -EnableBGP -RouterId 1.1.1.1 -LocalAS 1234
Enable BGP
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting
-EnableOspfRouteRedistribution:$false -Confirm:$false
Disable OSPF Route Redistribution without confirmation.
RELATED LINKS
SYNOPSIS
Configures global routing configuration of an existing NSX Logical Router
SYNTAX
Set-NsxLogicalRouterRouting [-LogicalRouterRouting] <XmlElement> [-Confirm] [-EnableOspf] [-ProtocolAddress
<IPAddress>] [-ForwardingAddress <IPAddress>] [-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 Logical Router is a distributed routing function implemented within
the ESXi kernel, and optimised for east west routing.
Logical Routers perform ipv4 and ipv6 routing functions for connected
networks and support both static and dynamic routing via OSPF and BGP.
The Set-NsxLogicalRouterRouting cmdlet configures the global routing
configuration of the specified LogicalRouter.
PARAMETERS
-LogicalRouterRouting <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
-ProtocolAddress <IPAddress>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ForwardingAddress <IPAddress>
Required? false
Position? named
Default value
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:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting -DefaultGatewayVnic 0
-DefaultGatewayAddress 10.0.0.101
Configure the default route of the LogicalRouter.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting -EnableECMP
Enable ECMP
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting -EnableOSPF -RouterId
1.1.1.1 -ForwardingAddress 1.1.1.1 -ProtocolAddress 1.1.1.2
Enable OSPF
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting |
Set-NsxLogicalRouterRouting -EnableBGP -RouterId 1.1.1.1 -LocalAS 1234
Enable BGP
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-NsxLogicalRouter | Get-NsxLogicalRouterRouting | Set-NsxLogicalRouterRouting
-EnableOspfRouteRedistribution:$false -Confirm:$false
Disable OSPF Route Redistribution without confirmation.
RELATED LINKS