ovirt.ovirt.ovirt_host_pm module – Module to manage power management of hosts in oVirt/RHV

Note

This module is part of the ovirt.ovirt collection (version 3.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ovirt.ovirt. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ovirt.ovirt.ovirt_host_pm.

New in ovirt.ovirt 1.0.0

Synopsis

• Module to manage power management of hosts in oVirt/RHV.

Requirements

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

• python >= 2.7

• ovirt-engine-sdk-python >= 4.4.0

Parameters

Parameter	Comments
address string	Address of the power management interface.
auth dictionary / required	Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
ca_file string	A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If ca_file parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable.
compress boolean	Flag indicating if compression is used for connection. Choices: false true ← (default)
headers dictionary	Dictionary of HTTP headers to be added to each API call.
hostname string	A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by OVIRT_HOSTNAME environment variable. Either url or hostname is required.
insecure boolean	A boolean flag that indicates if the server TLS certificate and host name should be checked. Choices: false ← (default) true
kerberos boolean	A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. Choices: false true
password string	The password of the user. Default value is set by OVIRT_PASSWORD environment variable.
timeout integer	Number of seconds to wait for response.
token string	Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.
url string	A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. Either url or hostname is required.
username string	The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable.
encrypt_options aliases: encrypt boolean	If true options will be encrypted when send to agent. Choices: false true
fetch_nested boolean	If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying nested_attributes. Choices: false ← (default) true
name aliases: host string / required	Name of the host to manage.
nested_attributes list / elements=string	Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true.
options dictionary	Dictionary of additional fence agent options (including Power Management slot). Additional information about options can be found at https://github.com/ClusterLabs/fence-agents/blob/master/doc/FenceAgentAPI.md.
order integer	Integer value specifying, by default it’s added at the end.
password string	Password of the user specified in username parameter.
poll_interval integer	Number of the seconds the module waits until another poll request on entity status is sent. Default: 3
port integer	Power management interface port.
state string	Should the host be present/absent. Choices: "present" ← (default) "absent"
timeout integer	The amount of time in seconds the module should wait for the instance to get into desired state. Default: 180
type string	Type of the power management. oVirt/RHV predefined values are drac5, ipmilan, rsa, bladecenter, alom, apc, apc_snmp, eps, wti, rsb, cisco_ucs, drac7, hpblade, ilo, ilo2, ilo3, ilo4, ilo_ssh, but user can have defined custom type.
username string	Username to be used to connect to power management interface.
wait boolean	yes if the module should wait for the entity to get into desired state. Choices: false true ← (default)

Notes

Note

• In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.4.0

Examples

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Add fence agent to host 'myhost'
- ovirt.ovirt.ovirt_host_pm:
    name: myhost
    address: 1.2.3.4
    options:
      myoption1: x
      myoption2: y
    username: admin
    password: admin
    port: 3333
    type: ipmilan

# Add fence agent to host 'myhost' using 'slot' option
- ovirt.ovirt.ovirt_host_pm:
    name: myhost
    address: 1.2.3.4
    options:
      myoption1: x
      myoption2: y
      slot: myslot
    username: admin
    password: admin
    port: 3333
    type: ipmilan


# Remove ipmilan fence agent with address 1.2.3.4 on host 'myhost'
- ovirt.ovirt.ovirt_host_pm:
    state: absent
    name: myhost
    address: 1.2.3.4
    type: ipmilan

Return Values

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

Key	Description
agent dictionary	Dictionary of all the agent attributes. Agent attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/agent. Returned: On success if agent is found.
id string	ID of the agent which is managed Returned: On success if agent is found. Sample: "7de90f31-222c-436c-a1ca-7e655bd5b60c"

Authors

• Ondra Machacek (@machacekondra)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)