Get-DrsVMHostRule

This cmdlet retrieves VM to VMHost DRS rules that match the specified filters.

Syntax

[[-Cluster]  <Cluster[]>]
[-Name  <String[]>]
[-Server  <VIServer[]>]
[-Type  <DrsVMHostRuleType[]>]
[-VMGroup  <DrsClusterVMGroup[]>]
[-VMHostGroup  <DrsClusterVMHostGroup[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional
Cluster
Cluster[] 1
  • wildcards
  • pipeline
  • Specifies the DRS clusters from which you want to retrieve rules.
    optional
    Name
    String[] named
  • wildcards
  • Specifies the names of the DRS rules 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
    DrsVMHostRuleType[] named Specifies the types of DRS rules you want to retrieve. This parameter accepts MustRunOn, ShouldRunOn, MustNotRunOn, and ShouldNotRunOn values.
    optional
    VMGroup
    DrsClusterVMGroup[] named
  • wildcards
  • pipeline
  • Filters rules by VM group.
    optional
    VMHostGroup
    DrsClusterVMHostGroup[] named
  • wildcards
  • pipeline
  • Filters rules by VMHost group.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsVMHostRule

    Examples


    Example 1

    Get-DrsVMHostRule -Type "MustRunOn"

    Retrieves all VM to VMHost DRS rules, which are of type "MustRunOn".

    Example 2

    $cluster = Get-Cluster "MyCluster"
    Get-DrsVMHostRule -VMHostGroup "MyDrsVMHostGroup" -Cluster $cluster

    Retrieves all available VM to VMHost DRS which include the "MyDrsVMHostGroup" DRS VMHost group in the "MyCluster" cluster.

    Related Commands

    Feedback

    Was this page helpful?