ovirt_host_pm - Module to manage power management of hosts in oVirt

New in version 2.3.

Synopsis

Module to manage power management of hosts in oVirt.

Requirements (on host that executes module)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0

Options

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`.
      password[required] - The password of the user.
      url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
      token - Token to be used instead of login with username/password.
      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.
      kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
      encrypt_options
      		 no
        If (true) options will be encrypted when send to agent.

        aliases: encrypt
        name
        		 yes
          Name of the the host to manage.

          aliases: host
          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
                      • present
                      • absent
                      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 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

                              # 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

                              Return Values

                              Common return values are documented here common_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 instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/agent. On success if agent is found.


                              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.0.0

                              This is an Extras Module

                              For more information on what this means please read modules_extra

                              For help in developing on modules, should you be so inclined, please read community, developing_test_pr and developing_modules.