Set-AzureIPForwarding

Module:

Azure Module

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

EnableIaaSIPForwardingParamSet

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

DisableIaaSIPForwardingParamSet

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

EnableSlotIPForwardingParamSet

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

DisableSlotIPForwardingParamSet

Set-AzureIPForwarding
    -ServiceName <String>
    -RoleName <String>
    [-Slot <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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DisableIaaSIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

DisableSlotIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Enable

Indicates that this cmdlet enables IP forwarding.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

EnableIaaSIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

EnableSlotIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NetworkInterfaceName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PassThru

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	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.

Parameter properties

Type:	AzureSMProfile
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-RoleName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

EnableSlotIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

DisableSlotIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ServiceName

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

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

EnableSlotIPForwardingParamSet

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

DisableSlotIPForwardingParamSet

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VM

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

Parameter properties

Type:	PersistentVMRoleContext
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

EnableIaaSIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

DisableIaaSIPForwardingParamSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Boolean

Related Links

• Get-AzureIPForwarding