Модуль community.general.one_image – Управление образами OpenNebula

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.one_image.

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Управление образами OpenNebula

Требования

Указанные ниже требования необходимы на хосте, который выполняет этот модуль.

pyone

Параметры

Параметр	Комментарии
api_password псевдонимы: api_token строка	Пароль или токен для аутентификации XMLRPC. Если не указано, используется значение переменной среды `ONE_PASSWORD`, если таковая существует.
api_url псевдонимы: api_endpoint строка	URL ENDPOINT сервера XMLRPC. Если не указано, используется значение переменной среды `ONE_URL`, если таковая существует.
api_username строка	Имя пользователя для аутентификации XMLRPC. Если не указано, используется значение переменной среды `ONE_USERNAME`, если таковая существует.
enabled булево	Должен ли образ быть включен или отключен. Варианты: `false` `true`
id целое число	`id` образа, которым вы хотите управлять.
name строка	`name` образа, которым вы хотите управлять.
new_name строка	Имя, которое будет присвоено существующему или новому образу. В случае клонирования, по умолчанию `new_name` будет использовать имя исходного образа с префиксом «Копия».
persistent булево добавлено в community.general 9.5.0	Должен ли образ быть постоянным или непостоянным. Варианты: `false` `true`
state строка	`present` - состояние, используемое для управления образом `absent` - удалить образ `cloned` - клонировать образ `renamed` - переименовать образ в `new_name` Варианты: `"present"` ← (по умолчанию) `"absent"` `"cloned"` `"renamed"`
validate_certs булево	Проверять ли TLS/SSL сертификаты или нет. Этот параметр игнорируется, если используется переменная среды `PYTHONHTTPSVERIFY`. Варианты: `false` `true` ← (по умолчанию)
wait_timeout целое число	Время ожидания достижения желаемого состояния перед тайм-аутом, в секундах. По умолчанию: `300`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или что может потребовать изменения в режиме `check_mode`), в режиме diff.

Примеры

- 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: Make the IMAGE persistent
  community.general.one_image:
    id: 37
    persistent: true

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
app_clones list / elements=integer added in community.general 9.5.0	Список ID клонов приложения образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `[1, 2, 3]`
clones list / elements=integer added in community.general 9.5.0	Список ID клонов образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `[1, 2, 3]`
cloning_id integer added in community.general 9.5.0	ID клонирования образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `-1`
cloning_ops integer added in community.general 9.5.0	Операции клонирования образа в секунду. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `0`
datastore integer added in community.general 9.5.0	Имя хранилища образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"image_datastore"`
datastore_id integer added in community.general 9.5.0	ID хранилища образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `100`
disk_type string added in community.general 9.5.0	Тип формата образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"0"`
fstype string added in community.general 9.5.0	Тип файловой системы образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"ext4"`
group_id integer	ID группы образа Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `1`
group_name string	Имя группы образа Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"one-users"`
id integer	ID образа Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `153`
name string	Имя образа Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"app1"`
owner_id integer	ID владельца образа Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `143`
owner_name string	Имя владельца образа Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"ansible-test"`
path string added in community.general 9.5.0	Путь к файловой системе образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"/var/tmp/hello.qcow2"`

permissions dictionary added in community.general 9.5.0	Разрешения образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `{"group_a": 0, "group_m": 0, "group_u": 0, "other_a": 0, "other_m": 0, "other_u": 0, "owner_a": 0, "owner_m": 0, "owner_u": 1}`
group_a string	Разрешения группы ADMIN для образа. Возвращается: success Пример: `"0"`
group_m string	Разрешения группы MANAGE для образа. Возвращается: success Пример: `"0"`
group_u string	Разрешения группы USAGE для образа. Возвращается: success Пример: `"0"`
other_a string	Разрешения ADMIN для других пользователей образа. Возвращается: success Пример: `"0"`
other_m string	Разрешения MANAGE для других пользователей образа. Возвращается: success Пример: `"0"`
other_u string	Разрешения USAGE для других пользователей образа. Возвращается: success Пример: `"0"`
owner_a string	Разрешения ADMIN владельца образа. Возвращается: success Пример: `"0"`
owner_m string	Разрешения MANAGE владельца образа. Возвращается: success Пример: `"0"`
owner_u string	Разрешения USAGE владельца образа. Возвращается: success Пример: `"1"`
persistent integer added in community.general 9.5.0	Статус постоянства образа (1 означает true, 0 означает false). Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `1`
running_vms integer	Количество запущенных виртуальных машин, использующих этот образ. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `7`
size integer added in community.general 9.5.0	Размер образа в мегабайтах. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `10000`
snapshots list / elements=string added in community.general 9.5.0	Список снимков образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `[{"active": 1, "allow_orphans": 1, "children": 0, "date": 123123, "name": "SampleName", "parent": 1, "size": 10228}]`
source string	Источник образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"/var/lib/one//datastores/100/somerandomstringxd"`
state string	Состояние экземпляра образа. Возвращается: when `state=present`, `state=cloned`, or `state=renamed` Пример: `"READY"`

target_snapshot integer added in community.general 9.5.0	Целевой снимок образа. Возвращаемое значение: при `state=present`, `state=cloned`, или `state=renamed` Пример: `1`
type string added in community.general 9.5.0	Тип образа. Возвращаемое значение: при `state=present`, `state=cloned`, или `state=renamed` Пример: `"0"`
used boolean	Используется ли образ Возвращаемое значение: при `state=present`, `state=cloned`, или `state=renamed` Пример: `true`
vms list / elements=integer added in community.general 9.5.0	Список ID виртуальных машин, использующих образ. Возвращаемое значение: при `state=present`, `state=cloned`, или `state=renamed` Пример: `[1, 2, 3]`

Авторы

Milan Ilic (@ilicmilan)

Ссылки на коллекцию

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