Documentation

vmware_drs_rule_facts - Gathers facts about DRS rule on the given cluster

New in version 2.5.

Synopsis

  • This module can be used to gather facts about DRS VM-VM and VM-HOST rules from the given cluster

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
cluster_name
Name of the cluster.
DRS facts for the given cluster will be returned.
This is required parameter if datacenter parameter is not provided.
datacenter
Name of the datacenter.
DRS facts for all the clusters from the given datacenter will be returned.
This is required parameter if cluster_name parameter is not provided.
hostname
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable supported added in version 2.6.
password
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable supported added in version 2.6.

aliases: pass, pwd
port
(added in 2.5)
 Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable supported added in version 2.6.
username
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable supported added in version 2.6.

aliases: user, admin
validate_certs
    Choices:
  • no
  • yes
Default:
True
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
Environment variable supported added in version 2.6.

Notes

Note

  • Tested on vSphere 6.5

Examples

- name: Gather DRS facts about given Cluster
  vmware_drs_rule_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
  register: cluster_drs_facts

- name: Gather DRS facts about all Clusters in given datacenter
  vmware_drs_rule_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: datacenter_name
  register: datacenter_drs_facts

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
drs_rule_facts
dict
 always
metadata about DRS rule from given cluster / datacenter

Sample:
{'DC0_C0': [{'rule_type': 'vm_vm_rule', 'rule_name': 'drs_rule_0001', 'rule_mandatory': True, 'rule_key': 1, 'rule_uuid': '52be5061-665a-68dc-3d25-85cd2d37e114', 'rule_enabled': True, 'rule_vms': ['VM_65', 'VM_146']}]}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Abhijeet Kasurde (@akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.