community.general.one_image module – Manages OpenNebula images
Note
This module is part of the community.general collection (version 8.6.4).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.one_image
.
Synopsis
Manages OpenNebula images
Aliases: cloud.opennebula.one_image
Requirements
The below requirements are needed on the host that executes this module.
pyone
Parameters
Parameter |
Comments |
---|---|
Password of the user to login into OpenNebula RPC server. If not set then the value of the |
|
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 |
|
Name of the user to login into the OpenNebula RPC server. If not set then the value of the |
|
Whether the image should be enabled or disabled. Choices:
|
|
A |
|
A |
|
A name that will be assigned to the existing or new image. In the case of cloning, by default |
|
Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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: false
- name: Enable the IMAGE by name
community.general.one_image:
name: bar-image
enabled: true
- 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 |
---|---|
image’s group id Returned: success Sample: |
|
image’s group name Returned: success Sample: |
|
image id Returned: success Sample: |
|
image name Returned: success Sample: |
|
image’s owner id Returned: success Sample: |
|
image’s owner name Returned: success Sample: |
|
count of running vms that use this image Returned: success Sample: |
|
state of image instance Returned: success Sample: |
|
is image in use Returned: success Sample: |