This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRNetworkTrafficRule

Short Description

Returns network traffic rules.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides two parameter sets.

To get network traffic rules by the network traffic rule name

Get-VBRNetworkTrafficRule [-Name <string[]>] [<CommonParameters>]

To get network traffic rules by the network traffic rule ID

Get-VBRNetworkTrafficRule [-Id <guid[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of network traffic rules.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Name	Specifies an array of names. The cmdlet will return network traffic rules with the specified names.	False	Named	False	False
Id	Specifies an array of IDs. The cmdlet will return network traffic rules with the specified IDs.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example

This command gets a network traffic rule by the network traffic rule name.

Get-VBRNetworkTrafficRule -Name "New rule"