Spec-Zone.ru › Ansible

Модуль community.general.one_image_info — сбор информации об образах OpenNebula

Примечание

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

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

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

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

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

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

  • Сбор информации об образах OpenNebula.

Требования

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

  • pyone

Параметры

Параметр

Комментарии

api_password

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

строка

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

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

api_url

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

строка

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

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

api_username

строка

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

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

ids

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

список / элементы=строка

Список идентификаторов образов, сведения о которых нужно собрать.

Модуль также принимает целые числа.

name

строка

name образа, сведения о котором собираются.

Если name начинается с ~, name используется как шаблон регулярного выражения, ограничивая список образов (сведения о которых возвращаются) теми, имена которых соответствуют указанному регулярному выражению.

Кроме того, если name начинается с ~*, выполняется сопоставление без учёта регистра.

Дополнительные сведения см. в примерах.

validate_certs

логический

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

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

Варианты:

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

wait_timeout

целое число

Время ожидания достижения требуемого состояния до истечения тайм-аута, в секундах.

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: full

Это действие не изменяет состояние.

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

diff_mode

Поддержка: N/A

Это действие не изменяет состояние.

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

Примеры

- name: Gather facts about all images
  community.general.one_image_info:
  register: result

- name: Print all images facts
  ansible.builtin.debug:
    msg: result

- name: Gather facts about an image using ID
  community.general.one_image_info:
    ids: 123

- name: Gather facts about an image using list of ID
  community.general.one_image_info:
    ids:
      - 123
      - 456
      - 789
      - 0

- name: Gather facts about an image using the name
  community.general.one_image_info:
    name: 'foo-image'
  register: foo_image

- name: Gather facts about all IMAGEs whose name matches regex 'app-image-.*'
  community.general.one_image_info:
    name: '~app-image-.*'
  register: app_images

- name: Gather facts about all IMAGEs whose name matches regex 'foo-image-.*' ignoring cases
  community.general.one_image_info:
    name: '~*foo-image-.*'
  register: foo_images

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

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

Ключ

Описание

images

list / elements=dictionary

Список сведений об образах.

Возвращается: при успехе

app_clones

list / elements=integer

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

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

Возвращается: при успехе

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

clones

list / elements=integer

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

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

Возвращается: при успехе

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

cloning_id

integer

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

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

Возвращается: при успехе

Пример: -1

cloning_ops

integer

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

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

Возвращается: при успехе

Пример: 0

datastore

integer

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

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

Возвращается: при успехе

Пример: "image_datastore"

datastore_id

integer

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

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

Возвращается: при успехе

Пример: 100

disk_type

integer

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

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

Возвращается: при успехе

Пример: 0

fstype

string

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

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

Возвращается: при успехе

Пример: "ext4"

group_id

integer

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

Возвращается: при успехе

Пример: 1

group_name

string

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

Возвращается: при успехе

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

id

integer

ID образа.

Возвращается: при успехе

Пример: 153

name

string

Имя образа.

Возвращается: при успехе

Пример: "app1"

owner_id

integer

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

Возвращается: при успехе

Пример: 143

owner_name

string

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

Возвращается: при успехе

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

path

string

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

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

Возвращается: при успехе

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

permissions

dictionary

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

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

Возвращается: при успехе

Пример: {"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).

Возвращается: при успехе

Пример: 1

running_vms

integer

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

Возвращается: при успехе

Пример: 7

size

integer

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

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

Возвращается: при успехе

Пример: 10000

snapshots

list / elements=string

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

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

Возвращается: при успехе

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

source

string

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

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

Возвращается: при успехе

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

state

string

Состояние образа.

Возвращается: при успехе

Пример: "READY"

target_snapshot

integer

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

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

Возвращается: при успехе

Пример: 1

type

integer

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

Тип образа.

Возвращается: при успехе

Пример: 0

used

boolean

Статус использования образа.

Возвращается: при успехе

Пример: true

vms

list / elements=integer

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

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

Возвращается: при успехе

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

Авторы

  • Milan Ilic (@ilicmilan)
  • Jan Meerkamp (@meerkampdvv)

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

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

© 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_info_module.html

Spec-Zone.ru

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