Set-AzureIPForwarding

Module:

Azure

Enables or disables IP forwarding.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Set-AzureIPForwarding
   -VM <PersistentVMRoleContext>
   -ServiceName <String>
   [-NetworkInterfaceName <String>]
   [-Enable]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Set-AzureIPForwarding
   -VM <PersistentVMRoleContext>
   -ServiceName <String>
   [-NetworkInterfaceName <String>]
   [-Disable]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Set-AzureIPForwarding
   -ServiceName <String>
   [-Slot <String>]
   -RoleName <String>
   [-NetworkInterfaceName <String>]
   [-Enable]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Set-AzureIPForwarding
   -ServiceName <String>
   [-Slot <String>]
   -RoleName <String>
   [-NetworkInterfaceName <String>]
   [-Disable]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Set-AzureIPForwarding cmdlet enables or disables IP forwarding for a virtual machine, for a platform as a service (PaaS) role, or a network adapter that belongs to a virtual machine or PaaS role.

Examples

Example 1: Enable IP forwarding for a virtual machine

PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "ContosoVM06" | Set-AzureIPForwarding -Enable

This command gets a virtual machine named ContosoVM06 for the service named ContosoService, and passes that virtual machine object to the current cmdlet. The current cmdlet enables IP forwarding for that virtual machine.

Example 2: Disable IP forwarding for a virtual machine

PS C:\> Get-AzureVM -ServiceName "ContosoService" -Name "ContosoVM06" | Set-AzureIPForwarding -Disable

This command gets a virtual machine named ContosoVM06 for the service named ContosoService, and passes that virtual machine object to the current cmdlet. The current cmdlet disables IP forwarding for that virtual machine.

Parameters

-Disable

Indicates that this cmdlet disables IP forwarding.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Enable

Indicates that this cmdlet enables IP forwarding.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NetworkInterfaceName

Specifies the name of the network adapter on which this cmdlet sets IP forwarding.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RoleName

Specifies the name of a PaaS role on which this cmdlet sets IP forwarding.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ServiceName

Specifies the name of a cloud service. The PaaS role belongs to the service that this parameter specifies.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Slot

Specifies a PaaS slot. The PaaS role for which this cmdlet sets forwarding has the slot that this parameter specifies. Valid values are:

• Production
• Staging

The default value is Production.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VM

Specifies the virtual machine object on which this cmdlet sets IP forwarding.

Type:	PersistentVMRoleContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Outputs

Boolean

Related Links

• Get-AzureIPForwarding