W3cubDocs

/Ansible 2.10

community.general.one_host – Manages OpenNebula Hosts

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.one_host.

Synopsis

  • Manages OpenNebula Hosts

Requirements

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

  • pyone

Parameters

Parameter Choices/Defaults Comments
api_password
string
The password or token for XMLRPC authentication.
If not specified then the value of the ONE_PASSWORD environment variable, if any, is used.

aliases: api_token
api_url
string
The ENDPOINT URL of the XMLRPC server.
If not specified then the value of the ONE_URL environment variable, if any, is used.

aliases: api_endpoint
api_username
string
The name of the user for XMLRPC authentication.
If not specified then the value of the ONE_USERNAME environment variable, if any, is used.
cluster_id
string
Default:
0
The cluster ID.
cluster_name
string
The cluster specified by name.
im_mad_name
string
Default:
"kvm"
The name of the information manager, this values are taken from the oned.conf with the tag name IM_MAD (name)
labels
string
The labels for this host.
name
string / required
Hostname of the machine to manage.
state
string
    Choices:
  • absent
  • present ←
  • enabled
  • disabled
  • offline
Takes the host to the desired lifecycle state.
If absent the host will be deleted from the cluster.
If present the host will be created in the cluster (includes enabled, disabled and offline states).
If enabled the host is fully operational.
disabled, e.g. to perform maintenance operations.
offline, host is totally offline.
template
string
The template or attribute changes to merge into the host template.

aliases: attributes
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether to validate the SSL certificates or not.
This parameter is ignored if PYTHONHTTPSVERIFY environment variable is used.
vmm_mad_name
string
Default:
"kvm"
The name of the virtual machine manager mad name, this values are taken from the oned.conf with the tag name VM_MAD (name)
wait_timeout
integer
Default:
300
Time to wait for the desired state to be reached before timeout, in seconds.

Examples

- name: Create a new host in OpenNebula
  community.general.one_host:
    name: host1
    cluster_id: 1
    api_url: http://127.0.0.1:2633/RPC2

- name: Create a host and adjust its template
  community.general.one_host:
    name: host2
    cluster_name: default
    template:
        LABELS:
            - gold
            - ssd
        RESERVED_CPU: -100

Authors

  • Rafael del Valle (@rvalle)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/one_host_module.html