< Back
Set-NsxEdgeInterface
Post
NAME Set-NsxEdgeInterface
SYNOPSIS
Conigures an NSX Edge Services Gateway Interface.
SYNTAX
Set-NsxEdgeInterface -Interface <XmlElement> -Name <String> -Type <String> -ConnectedTo <Object> [-PrimaryAddress
<String>] [-SubnetPrefixLength <String>] [-SecondaryAddresses <String[]>] [-MTU <Int32>] [-EnableProxyArp]
[-EnableSendICMPRedirects] [-Connected] [-Confirm] [-Connection <PSObject>] [<CommonParameters>]
Set-NsxEdgeInterface -Interface <XmlElement> -Name <String> -Type <String> -ConnectedTo <Object> -AddressSpec
<XmlElement[]> [-MTU <Int32>] [-EnableProxyArp] [-EnableSendICMPRedirects] [-Connected] [-Confirm] [-Connection
<PSObject>] [<CommonParameters>]
DESCRIPTION
NSX ESGs can host up to 10 interfaces and up to 200 subinterfaces, each of
which can be configured with multiple properties.
ESGs support interfaces connected to either VLAN backed port groups or NSX
Logical Switches.
Use Set-NsxEdgeInterface to change (including overwriting) the configuration
of an interface.
PARAMETERS
-Interface <XmlElement>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Type <String>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ConnectedTo <Object>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrimaryAddress <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SubnetPrefixLength <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecondaryAddresses <String[]>
Required? false
Position? named
Default value @()
Accept pipeline input? false
Accept wildcard characters? false
-AddressSpec <XmlElement[]>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MTU <Int32>
Required? false
Position? named
Default value 1500
Accept pipeline input? false
Accept wildcard characters? false
-EnableProxyArp [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableSendICMPRedirects [<SwitchParameter>]
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Connected [<SwitchParameter>]
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value True
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:\\>$interface = Get-NsxEdge Edge01 | Get-NsxEdgeInterface -Index 4
$interface | Set-NsxEdgeInterface -Name "vNic4" -Type internal
-ConnectedTo $ls4 -PrimaryAddress $ip4 -SubnetPrefixLength 24
Get an interface, then update it.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$add1 = New-NsxAddressSpec -PrimaryAddress 11.11.11.11 -SubnetPrefixLength 24 -SecondaryAddresses
11.11.11.12, 11.11.11.13
$add2 = New-NsxAddressSpec -PrimaryAddress 22.22.22.22 -SubnetPrefixLength 24 -SecondaryAddresses 22.22.22.23
Get-NsxEdge Edge01 | Get-NsxEdgeInterface -index 5 | Set-NsxEdgeInterface -ConnectedTo $ls4 -AddressSpec
$add1,$add2
-name "New Edge with Spec" -type internal
Adds two addresses, precreated via New-AddressSpec to ESG Edge01 vnic 5
RELATED LINKS
SYNOPSIS
Conigures an NSX Edge Services Gateway Interface.
SYNTAX
Set-NsxEdgeInterface -Interface <XmlElement> -Name <String> -Type <String> -ConnectedTo <Object> [-PrimaryAddress
<String>] [-SubnetPrefixLength <String>] [-SecondaryAddresses <String[]>] [-MTU <Int32>] [-EnableProxyArp]
[-EnableSendICMPRedirects] [-Connected] [-Confirm] [-Connection <PSObject>] [<CommonParameters>]
Set-NsxEdgeInterface -Interface <XmlElement> -Name <String> -Type <String> -ConnectedTo <Object> -AddressSpec
<XmlElement[]> [-MTU <Int32>] [-EnableProxyArp] [-EnableSendICMPRedirects] [-Connected] [-Confirm] [-Connection
<PSObject>] [<CommonParameters>]
DESCRIPTION
NSX ESGs can host up to 10 interfaces and up to 200 subinterfaces, each of
which can be configured with multiple properties.
ESGs support interfaces connected to either VLAN backed port groups or NSX
Logical Switches.
Use Set-NsxEdgeInterface to change (including overwriting) the configuration
of an interface.
PARAMETERS
-Interface <XmlElement>
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Name <String>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Type <String>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ConnectedTo <Object>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrimaryAddress <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SubnetPrefixLength <String>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SecondaryAddresses <String[]>
Required? false
Position? named
Default value @()
Accept pipeline input? false
Accept wildcard characters? false
-AddressSpec <XmlElement[]>
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MTU <Int32>
Required? false
Position? named
Default value 1500
Accept pipeline input? false
Accept wildcard characters? false
-EnableProxyArp [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EnableSendICMPRedirects [<SwitchParameter>]
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Connected [<SwitchParameter>]
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value True
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:\\>$interface = Get-NsxEdge Edge01 | Get-NsxEdgeInterface -Index 4
$interface | Set-NsxEdgeInterface -Name "vNic4" -Type internal
-ConnectedTo $ls4 -PrimaryAddress $ip4 -SubnetPrefixLength 24
Get an interface, then update it.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>$add1 = New-NsxAddressSpec -PrimaryAddress 11.11.11.11 -SubnetPrefixLength 24 -SecondaryAddresses
11.11.11.12, 11.11.11.13
$add2 = New-NsxAddressSpec -PrimaryAddress 22.22.22.22 -SubnetPrefixLength 24 -SecondaryAddresses 22.22.22.23
Get-NsxEdge Edge01 | Get-NsxEdgeInterface -index 5 | Set-NsxEdgeInterface -ConnectedTo $ls4 -AddressSpec
$add1,$add2
-name "New Edge with Spec" -type internal
Adds two addresses, precreated via New-AddressSpec to ESG Edge01 vnic 5
RELATED LINKS