Spec-Zone.ru › Ansible

Модуль community.general.one_image_info – Сбор информации об изображениях OpenNebula

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 будет использоваться как шаблон регулярного выражения,

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

Также, если имя начинается с ~*, будет выполнено нечувствительное к регистру сопоставление.

См. примеры для получения более подробной информации.

validate_certs

булево

Требовать проверку сертификатов TLS/SSL или нет.

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

Варианты:

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

wait_timeout

целое число

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

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

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

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

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

diff_mode

Поддержка: Нет

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

Вернёт подробности о том, что изменилось (или, возможно, требует изменения в check_mode), когда режим diff активен.

Примеры

- 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

complex

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

Возвращается: success

app_clones

список / элементы=целое число

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

Список идентификаторов app_clones изображения.

Возвращается: success

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

clones

список / элементы=целое число

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

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

Возвращается: success

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

cloning_id

целое число

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

Идентификатор клонирования изображения.

Возвращается: success

Пример: -1

cloning_ops

целое число

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

Операции клонирования изображения в секунду.

Возвращается: success

Пример: 0

datastore

целое число

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

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

Возвращается: success

Пример: "image_datastore"

datastore_id

целое число

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

Идентификатор хранилища данных изображения.

Возвращается: success

Пример: 100

disk_type

целое число

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

Тип формата изображения.

Возвращается: success

Пример: 0

fstype

строка

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

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

Возвращается: success

Пример: "ext4"

group_id

целое число

Идентификатор группы изображения

Возвращается: success

Пример: 1

group_name

строка

Имя группы изображения.

Возвращается: success

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

id

целое число

Идентификатор изображения.

Возвращается: success

Пример: 153

name

строка

Имя изображения.

Возвращается: success

Пример: "app1"

owner_id

целое число

Идентификатор владельца изображения.

Возвращается: success

Пример: 143

owner_name

строка

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

Возвращается: success

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

path

строка

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

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

Возвращается: success

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

permissions

dictionary

added in community.general 9.5.0

Права доступа к образу.

Возвращено: success

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

Возвращено: success

Пример: 1

running_vms

integer

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

Возвращено: success

Пример: 7

size

integer

added in community.general 9.5.0

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

Возвращено: success

Пример: 10000

snapshots

list / elements=string

added in community.general 9.5.0

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

Возвращено: success

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

source

string

added in community.general 9.5.0

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

Возвращено: success

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

state

string

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

Возвращено: success

Пример: "READY"

target_snapshot

integer

added in community.general 9.5.0

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

Возвращено: success

Пример: 1

тип

целое число

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

Тип изображения.

Возвращаемое значение: успех

Пример: 0

используется

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

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

Возвращаемое значение: успех

Пример: true

vms

список / элементы=целое число

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

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

Возвращаемое значение: успех

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

Авторы

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

Ссылки на сборку

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

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

Spec-Zone.ru

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