< Back
Get-DrsRule
Post
NAME Get-DrsRule
SYNOPSIS
This cmdlet retrieves the list of DRS rules for the specified clusters.
SYNTAX
Get-DrsRule [[-Name] <String[]>] [-Cluster] <Cluster[]> [[-VM] <VirtualMachine[]>] [-Server <VIServer[]>] [-Type
<ResourceSchedulingRuleType[]>] [<CommonParameters>]
Get-DrsRule [[-Name] <String[]>] [-Cluster] <Cluster[]> [[-VM] <VirtualMachine[]>] [-Server <VIServer[]>] [-VMHost
<VMHost[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the list of DRS rules for the specified clusters. Each rule defines the virtual machines
that can run on the same host (affinity rule) or must run on different hosts (anti-affinity).
Note: To retrieve VMHostAffinity rules, you need to state this explicitly by using the Type or the VMHost
parameter. Otherwise, this cmdlet returns VMAffinity and VMAntiAffinity rules.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters for which you want to retrieve the DRS rules.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the name of the DRS rule you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Type <ResourceSchedulingRuleType[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
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.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VMHost <VMHost[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more DrsRule objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... sRule.html
New-DrsRule
Remove-DrsRule
Set-DrsRule
SYNOPSIS
This cmdlet retrieves the list of DRS rules for the specified clusters.
SYNTAX
Get-DrsRule [[-Name] <String[]>] [-Cluster] <Cluster[]> [[-VM] <VirtualMachine[]>] [-Server <VIServer[]>] [-Type
<ResourceSchedulingRuleType[]>] [<CommonParameters>]
Get-DrsRule [[-Name] <String[]>] [-Cluster] <Cluster[]> [[-VM] <VirtualMachine[]>] [-Server <VIServer[]>] [-VMHost
<VMHost[]>] [<CommonParameters>]
DESCRIPTION
This cmdlet retrieves the list of DRS rules for the specified clusters. Each rule defines the virtual machines
that can run on the same host (affinity rule) or must run on different hosts (anti-affinity).
Note: To retrieve VMHostAffinity rules, you need to state this explicitly by using the Type or the VMHost
parameter. Otherwise, this cmdlet returns VMAffinity and VMAntiAffinity rules.
PARAMETERS
-Cluster <Cluster[]>
Specifies the clusters for which you want to retrieve the DRS rules.
Required? true
Position? 2
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the name of the DRS rule you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Type <ResourceSchedulingRuleType[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
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.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VMHost <VMHost[]>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more DrsRule objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... sRule.html
New-DrsRule
Remove-DrsRule
Set-DrsRule