Spec-Zone.ru › Ansible 2.11

theforeman.foreman.user – Управление пользователями

Примечание

Этот плагин входит в коллекцию theforeman.foreman (версия 1.5.1).

Для его установки используйте: ansible-galaxy collection install theforeman.foreman.

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

Введено в версии 1.0.0: of theforeman.foreman

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

Обзор

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

Требования

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

  • requests

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin
boolean
    Варианты:
  • нет ←
  • да
Является ли пользователь администратором
auth_source
строка
Источник аутентификации, где существует пользователь
default_location
строка
Местоположение, которое пользователь использует по умолчанию
default_organization
строка
Организация, которую пользователь использует по умолчанию
description
строка
Описание пользователя
firstname
строка
Имя пользователя
lastname
строка
Фамилия пользователя
locale
строка
    Варианты:
  • ca
  • de
  • en
  • en_GB
  • es
  • fr
  • gl
  • it
  • ja
  • ko
  • nl_NL
  • pl
  • pt_BR
  • ru
  • sv_SE
  • zh_CN
  • zh_TW
Языковой регион пользователя
locations
список / элементы=строка
Список мест, к которым должен быть назначен объект
login
строка / обязательно
Имя пользователя

псевдонимы: имя
mail
строка
Электронный адрес пользователя
Требуется при создании нового пользователя
organizations
список / элементы=строка
Список организаций, которым должен быть назначен объект
password
строка / обязательно
Пароль пользователя, имеющего доступ к серверу Foreman.
Если значение не указано в задаче, будет использоваться значение переменной окружения FOREMAN_PASSWORD.
roles
список / элементы=строка
Список ролей, назначенных пользователю
server_url
строка / обязательно
URL сервера Foreman.
Если значение не указано в задаче, будет использоваться значение переменной окружения FOREMAN_SERVER_URL.
state
строка
    Варианты:
  • настоящее ←
  • отсутствует
Состояние объекта
timezone
строка
    Варианты: ... (Список часовых поясов)
Часовой пояс для пользователя
Если пусто, будет использован часовой пояс браузера.
user_password
строка
Пароль для пользователя
username
строка / обязательно
Имя пользователя, имеющего доступ к серверу Foreman.
Если значение не указано в задаче, будет использоваться значение переменной окружения FOREMAN_USERNAME.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Утверждать ли сертификаты TLS сервера Foreman.
Если значение не указано в задаче, будет использоваться значение переменной окружения FOREMAN_VALIDATE_CERTS.

Примеры

- name: Create a user
  theforeman.foreman.user:
    name: test
    firstname: Test
    lastname: Userson
    mail: test.userson@example.com
    description: Dr. Test Userson
    admin: no
    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

Возвращаемые значения

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

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

users
список / элементы=словарь
успех
Список пользователей.



Авторы

  • Christoffer Reijer (@ephracis) Basalt AB

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/user_module.html

Spec-Zone.ru

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