Spec-Zone.ru › Ansible

Модуль theforeman.foreman.user — Управление пользователями

Примечание

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

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

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

Для использования в плейбуке укажите: theforeman.foreman.user.

Добавлен в theforeman.foreman 1.0.0

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

Обзор

  • Создание, обновление и удаление пользователей

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

Требования

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

  • requests

Параметры

Параметр

Комментарии

admin

boolean

Является ли пользователь администратором

Выбор:

  • false
  • true

auth_source

string

Источник аутентификации, в котором существует пользователь

default_location

string

Местоположение, используемое пользователем по умолчанию

default_organization

string

Организация, используемая пользователем по умолчанию

description

string

Описание пользователя

firstname

string

Имя пользователя

lastname

string

Фамилия пользователя

locale

string

Языковой регион пользователя

Выбор:

  • "ca"
  • "de"
  • "en"
  • "en_GB"
  • "es"
  • "fr"
  • "gl"
  • "it"
  • "ja"
  • "ko"
  • "nl_NL"
  • "pl"
  • "pt_BR"
  • "ru"
  • "sv_SE"
  • "zh_CN"
  • "zh_TW"

locations

list / elements=string

Список местоположений, которые должны быть назначены сущности

login

aliases: name

string / обязательно

Имя пользователя

mail

string

Электронный адрес пользователя

Требуется при создании нового пользователя

organizations

list / elements=string

Список организаций, которые должны быть назначены сущности

password

string / обязательно

Пароль пользователя, имеющего доступ к серверу Foreman.

Если значение не указано в задаче, будет использовано значение переменной среды FOREMAN_PASSWORD.

roles

list / elements=string

Список ролей, назначенных пользователю

server_url

string / обязательно

URL сервера Foreman.

Если значение не указано в задаче, будет использовано значение переменной среды FOREMAN_SERVER_URL.

state

string

Состояние сущности

Выбор:

  • "present" ← (по умолчанию)
  • "absent"
END_OF_DOCUMENT_MARKER

часовой пояс

строка

Часовой пояс пользователя

Если пусто, будет использоваться часовой пояс браузера.

Варианты:

  • "International Date Line West"
  • "American Samoa"
  • "Midway Island"
  • "Hawaii"
  • "Alaska"
  • "Pacific Time (US & Canada)"
  • "Tijuana"
  • "Arizona"
  • "Chihuahua"
  • "Mazatlan"
  • "Mountain Time (US & Canada)"
  • "Central America"
  • "Central Time (US & Canada)"
  • "Guadalajara"
  • "Mexico City"
  • "Monterrey"
  • "Saskatchewan"
  • "Bogota"
  • "Eastern Time (US & Canada)"
  • "Indiana (East)"
  • "Lima"
  • "Quito"
  • "Atlantic Time (Canada)"
  • "Caracas"
  • "Georgetown"
  • "La Paz"
  • "Puerto Rico"
  • "Santiago"
  • "Newfoundland"
  • "Brasilia"
  • "Buenos Aires"
  • "Greenland"
  • "Montevideo"
  • "Mid-Atlantic"
  • "Azores"
  • "Cape Verde Is."
  • "Dublin"
  • "Edinburgh"
  • "Lisbon"
  • "London"
  • "Monrovia"
  • "UTC"
  • "Amsterdam"
  • "Belgrade"
  • "Berlin"
  • "Bern"
  • "Bratislava"
  • "Brussels"
  • "Budapest"
  • "Casablanca"
  • "Copenhagen"
  • "Ljubljana"
  • "Madrid"
  • "Paris"
  • "Prague"
  • "Rome"
  • "Sarajevo"
  • "Skopje"
  • "Stockholm"
  • "Vienna"
  • "Warsaw"
  • "West Central Africa"
  • "Zagreb"
  • "Zurich"
  • "Athens"
  • "Bucharest"
  • "Cairo"
  • "Harare"
  • "Helsinki"
  • "Jerusalem"
  • "Kaliningrad"
  • "Kyiv"
  • "Pretoria"
  • "Riga"
  • "Sofia"
  • "Tallinn"
  • "Vilnius"
  • "Baghdad"
  • "Istanbul"
  • "Kuwait"
  • "Minsk"
  • "Moscow"
  • "Nairobi"
  • "Riyadh"
  • "St. Petersburg"
  • "Tehran"
  • "Abu Dhabi"
  • "Baku"
  • "Muscat"
  • "Samara"
  • "Tbilisi"
  • "Volgograd"
  • "Yerevan"
  • "Kabul"
  • "Ekaterinburg"
  • "Islamabad"
  • "Karachi"
  • "Tashkent"
  • "Chennai"
  • "Kolkata"
  • "Mumbai"
  • "New Delhi"
  • "Sri Jayawardenepura"
  • "Kathmandu"
  • "Almaty"
  • "Astana"
  • "Dhaka"
  • "Urumqi"
  • "Rangoon"
  • "Bangkok"
  • "Hanoi"
  • "Jakarta"
  • "Krasnoyarsk"
  • "Novosibirsk"
  • "Beijing"
  • "Chongqing"
  • "Hong Kong"
  • "Irkutsk"
  • "Kuala Lumpur"
  • "Perth"
  • "Singapore"
  • "Taipei"
  • "Ulaanbaatar"
  • "Osaka"
  • "Sapporo"
  • "Seoul"
  • "Tokyo"
  • "Yakutsk"
  • "Adelaide"
  • "Darwin"
  • "Brisbane"
  • "Canberra"
  • "Guam"
  • "Hobart"
  • "Melbourne"
  • "Port Moresby"
  • "Sydney"
  • "Vladivostok"
  • "Magadan"
  • "New Caledonia"
  • "Solomon Is."
  • "Srednekolymsk"
  • "Auckland"
  • "Fiji"
  • "Kamchatka"
  • "Marshall Is."
  • "Wellington"
  • "Chatham Is."
  • "Nuku'alofa"
  • "Samoa"
  • "Tokelau Is."

пароль_пользователя

строка

Пароль пользователя.

При установке этого параметра модуль не будет идемпотентным.

имя_пользователя

строка / обязательный

Имя пользователя, используемого для доступа к серверу Foreman.

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

проверять_сертификаты

булево

Необходимо ли проверять сертификаты TLS сервера Foreman.

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

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

режим_проверки

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

Может работать в режиме проверки и возвращать прогноз изменения состояния без изменения сущности

режим_сравнения

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

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

Примеры

- name: Create a user
  theforeman.foreman.user:
    name: test
    firstname: Test
    lastname: Userson
    mail: test.userson@example.com
    description: Dr. Test Userson
    admin: false
    user_password: s3cret
    default_location: Test Location
    default_organization: Test Organization
    auth_source: Internal
    timezone: Stockholm
    locale: sv_SE
    roles:
      - Manager
    locations:
      - Test Location
    organizations:
      - Test Organization
    state: present

- name: Update a user
  theforeman.foreman.user:
    name: test
    firstname: Tester
    state: present

- name: Change password
  theforeman.foreman.user:
    name: test
    user_password: newp@ss

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

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

Ключ

Описание

сущность

словарь

Конечное состояние затронутых сущностей, сгруппированных по их типу.

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

пользователи

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

Список пользователей.

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

Авторы

  • Кристоффер Рейер (@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/user_module.html

Spec-Zone.ru

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