Edit

Share via

Get-AzureIPForwarding

  • Reference
Module:
Azure

Gets the status of 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

Get-AzureIPForwarding
   -VM <PersistentVMRoleContext>
   -ServiceName <String>
   [-NetworkInterfaceName <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureIPForwarding
   -ServiceName <String>
   [-Slot <String>]
   -RoleName <String>
   [-NetworkInterfaceName <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureIPForwarding cmdlet gets the status of IP forwarding.

Examples

Example 1: Get IP forwarding status for a virtual machine

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

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 gets the status of IP forwarding for that virtual machine.

Parameters

-NetworkInterfaceName

Specifies the name of the network adapter for which this cmdlet gets IP forwarding status.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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 for which this cmdlet gets IP forwarding status.

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 gets forwarding status 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 for which this cmdlet gets IP forwarding status.

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

Outputs

String