< Back
Set-NsxEdge
Post
NAME Set-NsxEdge
SYNOPSIS
Configures an existing NSX Edge Services Gateway Raw configuration.
SYNTAX
Set-NsxEdge [-Edge] <XmlElement> [-Confirm] [[-userName] <String>] [[-password] <String>] [[-remoteAccess]
<Boolean>] [[-passwordExpiry] <Int32>] [[-sshLoginBannerText] <String>] [[-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 support interfaces connected to either VLAN backed port groups or NSX
Logical Switches.
Use the Set-NsxEdge to perform updates to the Raw XML config for an ESG
to enable basic support for manipulating Edge features that arent supported
by specific PowerNSX cmdlets.
PARAMETERS
-Edge <XmlElement>
Required? true
Position? 1
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
-userName <String>
cliSettings
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <String>
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-remoteAccess <Boolean>
Required? false
Position? 4
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-passwordExpiry <Int32>
Required? false
Position? 5
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sshLoginBannerText <String>
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? 7
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:\\>$edge = Get-NsxEdge Edge01
PS C:\\>$edge.features.firewall.enabled = "false"
PS C:\\>$edge | Set-NsxEdge
Disable the Edge Firewall on ESG Edge01
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -password Vmware1!Vmware1!
Change the SSH Password
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -remoteAccess:$true
Enable the SSH on ESG (you can use also use Enable-NsxSSHEdgeSSH)
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -username powernsx -password Vmware1!Vmware1!
Set the SSH username to PowerNSX (You need to change/set the password on the sametime)
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -sshLoginBannerText "My Login Banner"
Change the SSH Login Banner
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -passwordExpiry 30
Change the SSH Password Expiration to 30 (days)
RELATED LINKS
SYNOPSIS
Configures an existing NSX Edge Services Gateway Raw configuration.
SYNTAX
Set-NsxEdge [-Edge] <XmlElement> [-Confirm] [[-userName] <String>] [[-password] <String>] [[-remoteAccess]
<Boolean>] [[-passwordExpiry] <Int32>] [[-sshLoginBannerText] <String>] [[-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 support interfaces connected to either VLAN backed port groups or NSX
Logical Switches.
Use the Set-NsxEdge to perform updates to the Raw XML config for an ESG
to enable basic support for manipulating Edge features that arent supported
by specific PowerNSX cmdlets.
PARAMETERS
-Edge <XmlElement>
Required? true
Position? 1
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
-userName <String>
cliSettings
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-password <String>
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-remoteAccess <Boolean>
Required? false
Position? 4
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-passwordExpiry <Int32>
Required? false
Position? 5
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-sshLoginBannerText <String>
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
PowerNSX Connection object
Required? false
Position? 7
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:\\>$edge = Get-NsxEdge Edge01
PS C:\\>$edge.features.firewall.enabled = "false"
PS C:\\>$edge | Set-NsxEdge
Disable the Edge Firewall on ESG Edge01
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -password Vmware1!Vmware1!
Change the SSH Password
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -remoteAccess:$true
Enable the SSH on ESG (you can use also use Enable-NsxSSHEdgeSSH)
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -username powernsx -password Vmware1!Vmware1!
Set the SSH username to PowerNSX (You need to change/set the password on the sametime)
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -sshLoginBannerText "My Login Banner"
Change the SSH Login Banner
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-NsxEdge Edge01 | Set-NsxEdge -passwordExpiry 30
Change the SSH Password Expiration to 30 (days)
RELATED LINKS