Модуль theforeman.foreman.role – Управление ролями

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.0).

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

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

Для использования в книге задач укажите: theforeman.foreman.role.

Новинка в theforeman.foreman 1.0.0

Обзор
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Обзор

Создание, обновление и удаление ролей

Псевдонимы: foreman_role

Требования

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

requests

Параметры

Параметр	Комментарии
описание строка	Описание роли
фильтры список / элементы=словарь	Фильтры с правами для этой роли
права список / элементы=строка / обязательно	Список прав
поиск строка	Условие фильтрации для ресурсов
местоположения список / элементы=строка	Список местоположений, к которым должна быть назначена сущность
имя строка / обязательно	Имя роли
организации список / элементы=строка	Список организаций, к которым должна быть назначена сущность
пароль строка / обязательно	Пароль пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
адрес_сервера строка / обязательно	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
состояние строка	Состояние сущности Выбор: `"present"` ← (по умолчанию) `"absent"`
имя_пользователя строка / обязательно	Имя пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs логическое	Проверять ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`. Выбор: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать предсказание о состоянии изменения без модификации сущности
diff_mode	Поддержка: полная	В режиме diff вернёт подробности о том, что изменилось (или, возможно, должно измениться в режиме check_mode)

Примеры

- name: role
  theforeman.foreman.role:
    name: "Provisioner"
    description: "Only provision on libvirt"
    locations:
      - "Uppsala"
    organizations:
      - "ACME"
    filters:
      - permissions:
          - view_hosts
        search: "owner_type = Usergroup and owner_id = 4"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

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

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

Ключ	Описание
entity словарь	Конечное состояние затронутых сущностей, сгруппированных по их типу. Возвращено: успех
roles список / элементы=словарь	Список ролей. Возвращено: успех

Авторы

Christoffer Reijer (@ephracis) Basalt AB

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

© 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/theforeman/foreman/role_module.html