ovirt_hosts - Module to manage hosts in oVirt

New in version 2.3.

Synopsis

Module to manage 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
    Host address. It can be either FQDN (preferred) or IP address.
    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.
      cluster
      		 no
        Name of the cluster, where host should be created.
        comment
        		 no
          Description of the host.
          force
          		 no
            If True host will be forcibly moved to desired state.
            kdump_integration
            		 no enabled
            • enabled
            • disabled
            Specify if host will have enabled Kdump integration.
            name
            		 yes
              Name of the the host to manage.
              override_iptables
              		 no
                If True host iptables will be overridden by host deploy script.
                password
                		 no
                  Password of the root. It's required in case public_key is set to False.
                  poll_interval
                  		 no 3
                    Number of the seconds the module waits until another poll request on entity status is sent.
                    public_key
                    		 no
                      True if the public key should be used to authenticate to host.
                      It's required in case password is not set.

                      aliases: ssh_public_key
                      spm_priority
                      		 no
                        SPM priority of the host. Integer value from 1 to 10, where higher number means higher priority.
                        state
                        		 no present
                        • present
                        • absent
                        • maintenance
                        • upgraded
                        • started
                        • restarted
                        • stopped
                        State which should a host to be in after successful completion.
                        timeout
                        		 no 180
                          The amount of time in seconds the module should wait for the instance to get into desired state.
                          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 host with username/password
- ovirt_hosts:
    cluster: Default
    name: myhost
    address: 10.34.61.145
    password: secret

# Add host using public key
- ovirt_hosts:
    public_key: true
    cluster: Default
    name: myhost2
    address: 10.34.61.145

# Maintenance
- ovirt_hosts:
    state: maintenance
    name: myhost

# Restart host using power management:
- ovirt_hosts:
    state: restarted
    name: myhost

# Upgrade host
- ovirt_hosts:
    state: upgraded
    name: myhost

# Remove host
- ovirt_hosts:
    state: absent
    name: myhost
    force: True

                            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
                            host Dictionary of all the host attributes. Host attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/host. On success if host is found.
                            id ID of the host which is managed On success if host is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c


                            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.