Get-DrsRule

Syntax

• Default
• VMHostRule

Get-DrsRule

[-Cluster]  <Cluster[]>
[[-VM]  <VirtualMachine[]>]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[-Type  <ResourceSchedulingRuleType[]>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Cluster	Cluster[]	1	wildcards pipeline	Specifies the clusters for which you want to retrieve the DRS rules.
optional	VM	VirtualMachine[]	2	wildcards pipeline	Specifies virtual machines to filter the DRS rules that reference them. Passing values to this parameter through a pipeline is deprecated and will be removed in a future release.
optional	Name	String[]	named	wildcards	Specifies the name of the DRS rule you want to retrieve.
optional	Server	VIServer[]	named	wildcards	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
optional	Type	ResourceSchedulingRuleType[]	named		Specifies the type of DRS rules you want to retrieve. This parameter accepts VMAntiAffinity, VMAffinity, and VMHostAffinity values. You cannot set this parameter, when the VMHost parameter is specified.

Get-DrsRule

[-Cluster]  <Cluster[]>
[[-VM]  <VirtualMachine[]>]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[-VMHost  <VMHost[]>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Cluster	Cluster[]	1	wildcards pipeline	Specifies the clusters for which you want to retrieve the DRS rules.
optional	VM	VirtualMachine[]	2	wildcards pipeline	Specifies virtual machines to filter the DRS rules that reference them. Passing values to this parameter through a pipeline is deprecated and will be removed in a future release.
optional	Name	String[]	named	wildcards	Specifies the name of the DRS rule you want to retrieve.
optional	Server	VIServer[]	named	wildcards	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
optional	VMHost	VMHost[]	named	pipeline	Specifies VM hosts to filter the DRS rules that reference them. When this parameter is specified, the cmdlet returns only VMHostAffinity rules. You cannot set this parameter, when the Type parameter is specified.

Output

VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsRule

Examples

---

Example 1

$myCluster = Get-Cluster -Name "MyCluster1"

Get-DrsRule -Cluster $myCluster -Name "*Rule1*"

Retrieves the DRS rules for the cluster stored in the $myCluster variable, whose names contain "Rule1".

Example 2

Get-Cluster -Name 'MyCluster1' | Get-DrsRule

Retrieves the virtual machine affinity and anti-affinity rules for the specified cluster by pipeline.

Example 3

$myVm1 = Get-VM -Name 'MyVm1'

$myCluster1 = Get-Cluster 'MyCluster1'

Get-DrsRule -Cluster $myCluster1 -VM $myVm1

Retrieves the virtual machine affinity and anti-affinity rules for the specified virtual machine in the specified cluster.

Example 4

Get-Cluster 'MyCluster1' | Get-DrsRule -Type VMHostAffinity

Retrieves virtual machine to host affinity rules for the specified cluster by pipeline.

Example 5

$myVMHost1 = Get-VMHost -Name 'MyVMHost1'

$myCluster1 = Get-Cluster -Name 'MyCluster1'

Get-DrsRule -Cluster $myCluster1 -VMHost $myVMHost1

Retrieves virtual machine to host affinity rules for the specified host and cluster.

Related Commands