community.general.one_image – Управляет изображениями OpenNebula
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.one_image.
Краткое описание
- Управляет изображениями OpenNebula
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python-oca
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_password строка | Пароль пользователя для входа на сервер RPC OpenNebula. Если не задан то используется значение переменной окружения ONE_PASSWORD. | |
| api_url строка | URL сервера RPC OpenNebula. Рекомендуется использовать HTTPS, чтобы имя пользователя/пароль не передавались по сети без шифрования. Если не задан, то используется значение переменной окружения ONE_URL. | |
| api_username строка | Имя пользователя для входа на сервер RPC OpenNebula. Если не задан то используется значение переменной окружения ONE_USERNAME. | |
| enabled булево |
| Включить или отключить изображение. |
| id целое число | Идентификатор изображения, которое требуется обработать. | |
| name строка | Имя изображения, которое требуется обработать. | |
| new_name строка | Имя, которое будет присвоено существующему или новому изображению. В случае клонирования, по умолчанию new_name примет имя исходного изображения с префиксом 'Копия от'. | |
| state строка |
| present - состояние, используемое для управления изображениемabsent - удалить изображениеcloned - клонировать изображениеrenamed - переименовать изображение на new_name.
|
Примеры
- name: Fetch the IMAGE by id
community.general.one_image:
id: 45
register: result
- name: Print the IMAGE properties
ansible.builtin.debug:
msg: 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
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| group_id целое число | success | id группы изображения Пример: 1 |
| group_name строка | success | имя группы изображения Пример: one-users |
| id целое число | success | идентификатор изображения Пример: 153 |
| name строка | success | имя изображения Пример: app1 |
| owner_id целое число | success | идентификатор владельца изображения Пример: 143 |
| owner_name строка | success | имя владельца изображения Пример: ansible-test |
| running_vms целое число | success | количество запущенных виртуальных машин, использующих это изображение Пример: 7 |
| state строка | success | состояние экземпляра изображения Пример: READY |
| used булево | success | изображение используется Пример: True |
Авторы
- Milan Ilic (@ilicmilan)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/one_image_module.html