community.general.ovirt_affinity_label_facts – Получение информации об одном или нескольких метках родства oVirt/RHV
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в книге задач укажите: community.general.ovirt_affinity_label_facts.
УСТЕРЕКШЕЕ
- Удалено в
-
версии 3.0.0
- Почему
-
При миграции на коллекцию было решено использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_affinity_label_info вместо этого.
Описание
- Получение информации об одной или нескольких метках родства oVirt/RHV.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию задано переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задано переменной среды OVIRT_PASSWORD.url- Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задано переменной среды OVIRT_URL. Требуется либо url, либо hostname.hostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задано переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname.token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задано переменной среды OVIRT_TOKEN.insecure - Флажок, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию задано переменной среды OVIRT_CAFILE.kerberos - Флажок, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые необходимо добавить к каждому вызову API. | |
| fetch_nested логическое |
| Если да, модуль получит дополнительные данные из API. Он будет получать только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| host строка | Имя хоста, метки родства которого должны быть перечислены. | |
| name строка | Имя меток родства, которые должны быть перечислены. | |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен истине. | |
| vm строка | Имя виртуальной машины, метки родства которой должны быть перечислены. |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_affinity_labels, которая содержит список меток родства. Для использования результата необходимо зарегистрировать его с помощью ключевого слова register. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: ansible.builtin.pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Gather information about all affinity labels, which names start with label
ovirt_affinity_label_info:
name: label*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_affinity_labels }}"
- name: >
Gather information about all affinity labels, which are assigned to VMs
which names start with postgres
ovirt_affinity_label_info:
vm: postgres*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_affinity_labels }}"
- name: >
Gather information about all affinity labels, which are assigned to hosts
which names start with west
ovirt_affinity_label_info:
host: west*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_affinity_labels }}"
- name: >
Gather information about all affinity labels, which are assigned to hosts
which names start with west or VMs which names start with postgres
ovirt_affinity_label_info:
host: west*
vm: postgres*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_affinity_labels }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_affinity_labels список / элементы=строка | В случае успеха. | Список словарей, описывающих метки родства. Атрибуты меток родства сопоставлены с ключами словаря, все атрибуты меток родства можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_label. |
Статус
- Этот модуль будет удален в версии 3.0.0. [устаревший]
- Для получения дополнительной информации см. УСТЕРЕКШЕЕ.
Авторы
- Ondra Machacek (@machacekondra)
© 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/ovirt_affinity_label_facts_module.html
