community.general.one_image module – Manages OpenNebula images

Note

This module is part of the community.general collection (version 4.8.3).

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 community.general.

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

Synopsis

  • Manages OpenNebula images

Requirements

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

  • pyone

Parameters

Parameter

Comments

api_password

string

Password of the user to login into OpenNebula RPC server. If not set

then the value of the ONE_PASSWORD environment variable is used.

api_url

string

URL of the OpenNebula RPC server.

It is recommended to use HTTPS so that the username/password are not

transferred over the network unencrypted.

If not set then the value of the ONE_URL environment variable is used.

api_username

string

Name of the user to login into the OpenNebula RPC server. If not set

then the value of the ONE_USERNAME environment variable is used.

enabled

boolean

Whether the image should be enabled or disabled.

Choices:

  • no

  • yes

id

integer

A id of the image you would like to manage.

name

string

A name of the image you would like to manage.

new_name

string

A name that will be assigned to the existing or new image.

In the case of cloning, by default new_name will take the name of the origin image with the prefix ‘Copy of’.

state

string

present - state that is used to manage the image

absent - delete the image

cloned - clone the image

renamed - rename the image to the new_name

Choices:

  • present ← (default)

  • absent

  • cloned

  • renamed

Examples

- name: Fetch the IMAGE by id
  community.general.one_image:
    id: 45
  register: result

- name: Print the IMAGE properties
  ansible.builtin.debug:
    var: result

- name: Rename existing IMAGE
  community.general.one_image:
    id: 34
    state: renamed
    new_name: bar-image

- name: Disable the IMAGE by id
  community.general.one_image:
    id: 37
    enabled: no

- name: Enable the IMAGE by name
  community.general.one_image:
    name: bar-image
    enabled: yes

- name: Clone the IMAGE by name
  community.general.one_image:
    name: bar-image
    state: cloned
    new_name: bar-image-clone
  register: result

- name: Delete the IMAGE by id
  community.general.one_image:
    id: '{{ result.id }}'
    state: absent

Return Values

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

Key

Description

group_id

integer

image’s group id

Returned: success

Sample: 1

group_name

string

image’s group name

Returned: success

Sample: “one-users”

id

integer

image id

Returned: success

Sample: 153

name

string

image name

Returned: success

Sample: “app1”

owner_id

integer

image’s owner id

Returned: success

Sample: 143

owner_name

string

image’s owner name

Returned: success

Sample: “ansible-test”

running_vms

integer

count of running vms that use this image

Returned: success

Sample: 7

state

string

state of image instance

Returned: success

Sample: “READY”

used

boolean

is image in use

Returned: success

Sample: true

Authors

  • Milan Ilic (@ilicmilan)