Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.one_image.

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

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

  • Управляет образами OpenNebula.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • pyone

Параметры

Параметр

Комментарии

api_password

псевдонимы: api_token

строка

Пароль или токен для аутентификации XMLRPC.

Если значение не указано, используется значение переменной окружения ONE_PASSWORD, если она задана.

api_url

псевдонимы: api_endpoint

строка

URL конечной точки сервера XMLRPC.

Если значение не указано, используется значение переменной окружения ONE_URL, если она задана.

api_username

строка

Имя пользователя для аутентификации XMLRPC.

Если значение не указано, используется значение переменной окружения ONE_USERNAME, если она задана.

create

логическое значение

добавлено в community.general 10.0.0

Создавать ли образ, если он отсутствует.

Игнорируется, если state=absent.

Варианты:

  • false
  • true

datastore_id

целое число

добавлено в community.general 10.0.0

Используется с create=true для указания хранилища данных для образа.

enabled

логическое значение

Включить или отключить образ.

Варианты:

  • false
  • true

id

целое число

id образа, которым нужно управлять.

name

строка

name образа, которым нужно управлять.

Обязательно, если create=true.

new_name

строка

Имя, присваиваемое существующему или новому образу.

При клонировании по умолчанию new_name устанавливается в имя исходного образа с префиксом «Copy of».

persistent

логическое значение

добавлено в community.general 9.5.0

Сделать ли образ постоянным или непостоянным.

Варианты:

  • false
  • true

state

строка

present — состояние, используемое для управления образом.

absent — удалить образ.

cloned — клонировать образ.

renamed — переименовать образ в new_name.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "cloned"
  • "renamed"

template

строка

добавлено в community.general 10.0.0

Используется с create=true для указания шаблона образа.

validate_certs

логическое значение

Проверять ли сертификаты TLS/SSL.

Этот параметр игнорируется, если используется переменная окружения PYTHONHTTPSVERIFY.

Варианты:

  • false
  • true ← (по умолчанию)

wait_timeout

целое число

добавлено в community.general 10.0.0

Время ожидания в секундах, пока образ не будет готов, удалён или клонирован.

По умолчанию: 60

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

Может работать в режиме check_mode и возвращать прогноз изменения статуса, не изменяя целевой узел.

diff_mode

Поддержка: отсутствует

Возвращает сведения об изменениях (или о том, что может потребовать изменения в check_mode) в режиме сравнения.

Примеры

- 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

- name: Make sure IMAGE is present
  community.general.one_image:
    name: myyy-image
    state: present
    create: true
    datastore_id: 100
    template: |
      PATH = "/var/tmp/image"
      TYPE = "OS"
      SIZE = 20512
      FORMAT = "qcow2"
      PERSISTENT = "Yes"
      DEV_PREFIX = "vd"

- name: Make sure IMAGE is present with a longer timeout
  community.general.one_image:
    name: big-image
    state: present
    create: true
    datastore_id: 100
    wait_timeout: 900
    template: |-
      PATH = "https://192.0.2.200/repo/tipa_image.raw"
      TYPE = "OS"
      SIZE = 82048
      FORMAT = "raw"
      PERSISTENT = "Yes"
      DEV_PREFIX = "vd"

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

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

Ключ

Описание

app_clones

list / elements=integer

добавлено в community.general 9.5.0

Список ID клонов приложения для образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: [1, 2, 3]

clones

list / elements=integer

добавлено в community.general 9.5.0

Список ID клонов образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: [1, 2, 3]

cloning_id

integer

добавлено в community.general 9.5.0

ID клонирования образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: -1

cloning_ops

integer

добавлено в community.general 9.5.0

Количество операций клонирования образа в секунду.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 0

datastore

integer

добавлено в community.general 9.5.0

Имя хранилища данных образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "image_datastore"

datastore_id

integer

добавлено в community.general 9.5.0

ID хранилища данных образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 100

disk_type

string

добавлено в community.general 9.5.0

Тип формата образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "0"

fstype

string

добавлено в community.general 9.5.0

Тип файловой системы образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "ext4"

group_id

integer

ID группы образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 1

group_name

string

Имя группы образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "one-users"

id

integer

ID образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 153

name

string

Имя образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "app1"

owner_id

integer

ID владельца образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 143

owner_name

string

Имя владельца образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "ansible-test"

path

string

добавлено в community.general 9.5.0

Путь к файлу образа в файловой системе.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "/var/tmp/hello.qcow2"

permissions

dictionary

добавлено в community.general 9.5.0

Разрешения образа.

Возвращается: при state=present, state=cloned или 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 для группы образа.

Возвращается: при успешном выполнении

Пример: "0"

group_m

string

Разрешения MANAGE для группы образа.

Возвращается: при успешном выполнении

Пример: "0"

group_u

string

Разрешения USAGE для группы образа.

Возвращается: при успешном выполнении

Пример: "0"

other_a

string

Разрешения ADMIN для остальных пользователей образа.

Возвращается: при успешном выполнении

Пример: "0"

other_m

string

Разрешения MANAGE для остальных пользователей образа.

Возвращается: при успешном выполнении

Пример: "0"

other_u

string

Разрешения USAGE для остальных пользователей образа.

Возвращается: при успешном выполнении

Пример: "0"

owner_a

string

Разрешения ADMIN для владельца образа.

Возвращается: при успешном выполнении

Пример: "0"

owner_m

string

Разрешения MANAGE для владельца образа.

Возвращается: при успешном выполнении

Пример: "0"

owner_u

string

Разрешения USAGE для владельца образа.

Возвращается: при успешном выполнении

Пример: "1"

persistent

integer

добавлено в community.general 9.5.0

Статус сохранения образа (1 означает true, 0 означает false).

Возвращается: при state=present, state=cloned или state=renamed

Пример: 1

running_vms

integer

Количество работающих виртуальных машин, использующих этот образ.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 7

size

integer

добавлено в community.general 9.5.0

Размер образа в мегабайтах.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 10000

snapshots

list / elements=string

добавлено в community.general 9.5.0

Список снимков образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: [{"active": 1, "allow_orphans": 1, "children": 0, "date": 123123, "name": "SampleName", "parent": 1, "size": 10228}]

source

string

Источник образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "/var/lib/one//datastores/100/somerandomstringxd"

state

string

Состояние экземпляра образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: "READY"

target_snapshot

integer

добавлено в community.general 9.5.0

Целевой снимок образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: 1

type

string

добавлено в 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

добавлено в community.general 9.5.0

Список ID виртуальных машин образа.

Возвращается: при state=present, state=cloned или state=renamed

Пример: [1, 2, 3]

Авторы

  • Milan Ilic (@ilicmilan)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос
  • Отправить отчёт об ошибке
  • Предложить новую функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API