Export (0) Print
Expand All
Expand Minimize

Add-VMNetworkAdapterExtendedAcl

Windows Server 2012 R2 and Windows 8.1

Updated: June 10, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Add-VMNetworkAdapterExtendedAcl

Creates an extended ACL for a virtual network adapter.

Syntax

Parameter Set: VMName
Add-VMNetworkAdapterExtendedAcl [-VMName] <String[]> [-Action] <VMNetworkAdapterExtendedAclAction> [-Direction] <VMNetworkAdapterExtendedAclDirection> [[-LocalIPAddress] <String> ] [[-RemoteIPAddress] <String> ] [[-LocalPort] <String> ] [[-RemotePort] <String> ] [[-Protocol] <String> ] [-Weight] <Int32> [-ComputerName <String[]> ] [-IdleSessionTimeout <Int32> ] [-IsolationID <Int32> ] [-Passthru] [-Stateful <Boolean> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ManagementOS
Add-VMNetworkAdapterExtendedAcl [-Action] <VMNetworkAdapterExtendedAclAction> [-Direction] <VMNetworkAdapterExtendedAclDirection> [[-LocalIPAddress] <String> ] [[-RemoteIPAddress] <String> ] [[-LocalPort] <String> ] [[-RemotePort] <String> ] [[-Protocol] <String> ] [-Weight] <Int32> -ManagementOS [-ComputerName <String[]> ] [-IdleSessionTimeout <Int32> ] [-IsolationID <Int32> ] [-Passthru] [-Stateful <Boolean> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ResourceObject
Add-VMNetworkAdapterExtendedAcl [-VMNetworkAdapter] <VMNetworkAdapterBase[]> [-Action] <VMNetworkAdapterExtendedAclAction> [-Direction] <VMNetworkAdapterExtendedAclDirection> [[-LocalIPAddress] <String> ] [[-RemoteIPAddress] <String> ] [[-LocalPort] <String> ] [[-RemotePort] <String> ] [[-Protocol] <String> ] [-Weight] <Int32> [-IdleSessionTimeout <Int32> ] [-IsolationID <Int32> ] [-Passthru] [-Stateful <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMObject
Add-VMNetworkAdapterExtendedAcl [-VM] <VirtualMachine[]> [-Action] <VMNetworkAdapterExtendedAclAction> [-Direction] <VMNetworkAdapterExtendedAclDirection> [[-LocalIPAddress] <String> ] [[-RemoteIPAddress] <String> ] [[-LocalPort] <String> ] [[-RemotePort] <String> ] [[-Protocol] <String> ] [-Weight] <Int32> [-IdleSessionTimeout <Int32> ] [-IsolationID <Int32> ] [-Passthru] [-Stateful <Boolean> ] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Add-VMNetworkAdapterExtendedAcl cmdlet creates an extended access control list (ACL) for a virtual network adapter. The ACL allows or denies access to a virtual machine network adapter for network packets based on source IP address, destination IP address, protocol, source port, and destination port.

Parameters

-Action<VMNetworkAdapterExtendedAclAction>

Specifies the action for the ACL. The acceptable values for this parameter are: 

-- Allow
-- Deny


Aliases

none

Required?

true

Position?

2

Default Value

None

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String[]>

Specifies an array of Hyper-V hosts. The cmdlet adds the ACL to the network adapters on the Hyper-V hosts that you specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Direction<VMNetworkAdapterExtendedAclDirection>

Specifies the direction of network traffic, from the perspective of the virtual machine, to which the ACL applies. The cmdlet adds an ACL that has the value that you specify. The acceptable values for this parameter are: 

-- Inbound
-- Outbound
-- Both

If you specify Both, the cmdlet adds the ACL as both inbound and outbound. If you run the Get-VMNetworkAdapterExtendedAcl cmdlet, the entry that you create appears in both the inbound ACL and the outbound ACL.


Aliases

none

Required?

true

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IdleSessionTimeout<Int32>

Specifies a time-out period, in seconds, for idle sessions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IsolationID<Int32>

Specifies an ID of a virtual subnet. The cmdlet adds an ACL that applies to traffic on the isolated network that you specify. The subnet uses virtual local area network (VLAN) or Hyper-V Network Virtualization. For more information about isolation IDs, see the Set-VmNetworkAdapterIsolation cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LocalIPAddress<String>

Specifies the local IP address for the ACL. For an inbound packet, the local address is the destination IP address. For an outbound packet, the local address is the source IP address. You can specify a host address or a subnet address, or specify a wildcard, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all IPv4 and IPv6 addresses.


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LocalPort<String>

Specifies the local port for the ACL. For an inbound TCP or UDP packet, the local port is the destination port. For an outbound packet, the local port is the source port.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManagementOS

Indicates that the cmdlet operates on the parent or host operating system. If you specify this parameter, this cmdlet creates an ACL that applies to the parent or host operating system.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Protocol<String>

Specifies the protocol that the ACL applies to. The acceptable values for this parameter are: 

-- TCP
-- UDP
-- ICMP
-- an integer IP protocol ID


Aliases

none

Required?

false

Position?

8

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemoteIPAddress<String>

Specifies the local IP address for the ACL. For an inbound packet, the remote address is the source IP address. For an outbound packet, the remote address is the destination IP address. You can specify a host address or a subnet address, or specify a wildcard, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all IPv4 and IPv6 addresses.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemotePort<String>

Specifies the remote port for the ACL. For an inbound TCP or UDP packet, the remote port is the source port. For an outbound packet, the remote port is the destination port.


Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Stateful<Boolean>

Indicates whether the ACL applies to packets in both directions of the same session. If you specify a value of $True, the ACL applies to a return packet even though that packet has the opposite direction with respect to the ACL.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VM<VirtualMachine[]>

Specifies an array of virtual machine objects. The cmdlet adds an ACL for the virtual machines that you specify. To obtain a virtual machine object, use the Get-VM cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMName<String[]>

Specifies an array of names of virtual machines. The cmdlet adds an ACL for the virtual machines that you specify.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMNetworkAdapter<VMNetworkAdapterBase[]>

Specifies an array VM network adapters as VMNetworkAdapterBase objects. The cmdlet adds an ACL to the adapters that you specify. To obtain a network adapter, use the Get-VMNetworkAdapter cmdlet.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMNetworkAdapterName<String>

Specifies the name of a virtual network adapter. The cmdlet adds an ACL to the adapter that you specify.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Weight<Int32>

Specifies the weight of an ACL entry. Larger weight values apply first, and once an ACL entry applies to a packet, other entries are no longer relevant for that packet.


Aliases

none

Required?

true

Position?

9

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.HyperV.PowerShell.VMNetworkAdapterExtendedAclSetting

Examples

Example 1: Create an ACL for Remote Desktop Protocol

This command creates a stateful inbound ACL that allows a remote device to connect to the virtual machine on port 3389, which is the port for Remote Desktop Protocol.


PS C:\> Add-VMNetworkAdapterExtendedAcl -VMName "TSQA01" -Action Allow -Direction Inbound -LocalPort "3389" -Protocol "TCP" -Weight 10 -Stateful $True

Example 2: Create an ACL to allow IGMP in both directions

This command creates an ACL that allows packets with a protocol ID of 2, which is IGMP. The ACL allows both inbound and outbound packets.


PS C:\> Add-VMNetworkAdapterExtendedAcl -VMName "TSQA02" -Action Allow -Direction Both -Protocol "2" -Weight 20

Example 3: Create an ACL to initiate a connection with timeout

This command creates a stateful ACL that allows outbound packets to a remote device by using TCP. If there is no activity for 3600 seconds, the connection times out.


PS C:\> Add-VMNetworkAdapterExtendedAcl -VMName "TSQA03" -Action Allow -Direction Outbound -RemotePort "80" -Protocol "TCP" -Weight 100 -Timeout 3600 -Stateful $True 

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft