openstack.cloud.identity_group модуль – Управление группой OpenStack идентичности (Keystone)

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

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

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в книге задач укажите: openstack.cloud.identity_group.

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Создание, обновление или удаление группы OpenStack идентичности (Keystone).

Требования

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

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
api_timeout integer	Сколько времени слой сокета должен ждать перед истечением времени ожидания для вызовов API. Если это пропущено, ничего не будет передано в библиотеку запросов.
auth dictionary	Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля аутентификации облака. Для подключаемого модуля password по умолчанию это будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других подключаемых модулей этот параметр должен будет содержать любые параметры, которые требуются этому подключаемому модулю аутентификации. Этот параметр не нужен, если предоставлено именованное облако или присутствуют переменные среды OpenStack OS_*.
auth_type string	Имя подключаемого модуля аутентификации для использования. Если облако использует что-то другое, кроме парольной аутентификации, имя подключаемого модуля должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответствующим образом.
ca_cert aliases: cacert string	Путь к пакету сертификатов CA, который может быть использован в качестве части проверки запросов API SSL.
client_cert aliases: cert string	Путь к клиентскому сертификату, который нужно использовать в качестве части транзакции SSL.
client_key aliases: key string	Путь к клиентскому ключу, который нужно использовать в качестве части транзакции SSL.
cloud any	Именованное облако или конфигурация облака для работы. Если cloud — это строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или если присутствуют переменные среды OpenStack OS_. Если cloud* — это словарь, он содержит полную конфигурацию облака, как это было бы в разделе clouds.yaml.
description string	Описание группы.
domain_id string	Идентификатор домена для создания группы.
interface aliases: endpoint_type string	Тип URL-адреса конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string / required	Имя группы
region_name string	Имя региона.
sdk_log_level string	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
state string	Должен ли ресурс присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Как долго ansible должен ждать запрошенный ресурс. По умолчанию: `180`
validate_certs aliases: verify boolean	Следует ли проверять запросы API SSL. До Ansible 2.3 это по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли ansible ждать, пока запрошенный ресурс не будет завершен. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Вместо предоставления явных значений могут использоваться стандартные переменные среды OpenStack, такие как OS_USERNAME.
Информация об аутентификации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в пьесах. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/

Примеры

- name: Create a group named "demo"
  openstack.cloud.identity_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Demo Group"
    domain_id: demoid

- name: Update the description on existing demo group
  openstack.cloud.identity_group:
    cloud: mycloud
    state: present
    name: demo
    description: "Something else"
    domain_id: demoid

- name: Delete group named demo
  openstack.cloud.identity_group:
    cloud: mycloud
    state: absent
    name: demo

Значения возврата

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

Ключ	Описание
group словарь	Словарь, описывающий группу идентификации. Возвращается: При успехе, когда state равно `present`.
description строка	Описание группы Возвращается: успешно Пример: `"Demo Group"`
domain_id строка	Домен для группы Возвращается: успешно Пример: `"default"`
id строка	Уникальный идентификатор группы Возвращается: успешно Пример: `"ee6156ff04c645f481a6738311aea0b0"`
name строка	Имя группы Возвращается: успешно Пример: `"demo"`

Авторы

OpenStack Ansible SIG

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

© 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/openstack/cloud/identity_group_module.html