New in version 2.3.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| address | no | Address of the power management interface. | ||
| auth | yes | Dictionary with values needed to create HTTP/HTTPS connection to oVirt: username[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable.password[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable.url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable.token - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.ca_file - 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.kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.headers - Dictionary of HTTP headers to be added to each API call. | ||
| encrypt_options | no | If (true) options will be encrypted when send to agent. aliases: encrypt | ||
| fetch_nested (added in 2.3)
| no | 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. | ||
| name | yes | Name of the host to manage. aliases: host | ||
| nested_attributes (added in 2.3)
| no | Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true. | ||
| options | no | Dictionary of additional fence agent options. Additional information about options can be found at https://fedorahosted.org/cluster/wiki/FenceArguments. | ||
| order | no | Integer value specifying, by default it's added at the end. | ||
| password | no | Password of the user specified in username parameter. | ||
| poll_interval | no | 3 | Number of the seconds the module waits until another poll request on entity status is sent. | |
| port | no | Power management interface port. | ||
| slot | no | Power management slot. | ||
| state | no | present |
| Should the host be present/absent. |
| timeout | no | 180 | The amount of time in seconds the module should wait for the instance to get into desired state. | |
| type | no | 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 | no | Username to be used to connect to power management interface. | ||
| wait | no |
True if the module should wait for the entity to get into desired state. |
# 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_host_pm:
name: myhost
address: 1.2.3.4
options:
myoption1: x
myoption2: y
username: admin
password: admin
port: 3333
type: ipmilan
# Remove ipmilan fence agent with address 1.2.3.4 on host 'myhost'
- ovirt_host_pm:
state: absent
name: myhost
address: 1.2.3.4
type: ipmilan
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| id | ID of the agent which is managed | On success if agent is found. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| agent | 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. | On success if agent is found. | dict |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ovirt_host_pm_module.html