/ home / ansible / ansible.builtin / v2.6.0 / module / vmware_drs_rule_facts

ansible.builtin.vmware_drs_rule_facts (v2.6.0) — module

Gathers facts about DRS rule on the given cluster

| "added in version" 2.5 of ansible.builtin"

Authors: Abhijeet Kasurde (@Akasurde)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.6.0

Description

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

Requirements

python >= 2.6
PyVmomi

Usage examples

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Inputs

port:
default: 443
description:
- The port number of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PORT)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: int

hostname:
description:
- 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 C(VMWARE_HOST)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: str

password:
aliases:
- pass
- pwd
description:
- The password of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: str

username:
aliases:
- admin
- user
description:
- The username of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable C(VMWARE_USER)
will be used instead.
- Environment variable support added in Ansible 2.6.
type: str

datacenter:
description:
- Name of the datacenter.
- DRS facts for all the clusters from the given datacenter will be returned.
- This is required parameter if C(cluster_name) parameter is not provided.

proxy_host:
description:
- Address of a proxy that will receive all HTTPS requests and relay them.
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST)
will be used instead.
- This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
required: false
type: str

proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT)
will be used instead.
required: false
type: int

cluster_name:
description:
- Name of the cluster.
- DRS facts for the given cluster will be returned.
- This is required parameter if C(datacenter) parameter is not provided.

validate_certs:
default: true
description:
- Allows connection when SSL certificates are not valid. Set to C(false) when certificates
are not trusted.
- If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS)
will be used instead.
- Environment variable support added in Ansible 2.6.
- If set to C(yes), please make sure Python >= 2.7.9 is installed on the given machine.
type: bool

Outputs

drs_rule_facts:
  description: metadata about DRS rule from given cluster / datacenter
  returned: always
  sample:
    DC0_C0:
    - rule_enabled: true
      rule_key: 1
      rule_mandatory: true
      rule_name: drs_rule_0001
      rule_type: vm_vm_rule
      rule_uuid: 52be5061-665a-68dc-3d25-85cd2d37e114
      rule_vms:
      - VM_65
      - VM_146
  type: dict

Install Ansible via pip