модуль community.general.pritunl_user — управление пользователями Pritunl с помощью API Pritunl

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.pritunl_user.

Добавлено в community.general 2.3.0

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

Обзор

Модуль для управления пользователями Pritunl с помощью API Pritunl.

Параметры

Параметр	Комментарии
organization псевдонимы: org строка / обязательный	Название организации, в которую входит пользователь.
pritunl_api_secret строка / обязательный	Секрет API находится в разделе «Администраторы > USERNAME > Секрет API».
pritunl_api_token строка / обязательный	Токен API пользователя-администратора Pritunl. Его необходимо включить в разделе «Администраторы > USERNAME > Включить аутентификацию по токену».
pritunl_url строка / обязательный	URL и порт сервера Pritunl, на котором включён API.
state строка	Если `present`, модуль добавляет пользователя `user_name` в `organization` Pritunl. Если `absent`, удаляет пользователя `user_name` из `organization` Pritunl. Варианты: `"present"` ← (по умолчанию) `"absent"`
user_disabled логический	Включить/отключить пользователя `user_name`. Варианты: `false` `true`
user_email строка	Адрес электронной почты, связанный с пользователем `user_name`.
user_gravatar логический	Включить/отключить использование Gravatar для пользователя `user_name`. Варианты: `false` `true`
user_groups список / элементы=строка	Список групп, связанных с пользователем `user_name`.
user_mac_addresses список / элементы=строка добавлено в community.general 5.0.0	Разрешённые MAC-адреса пользователя `user_name`.
user_name строка / обязательный	Имя пользователя, которого нужно создать или удалить в Pritunl.
user_type строка	Тип пользователя `user_name`. Варианты: `"client"` ← (по умолчанию) `"server"`
validate_certs логический	Проверять ли сертификаты. Значение `false` не следует устанавливать, кроме случаев, когда вы полностью уверены, что соединение с сервером не может подвергнуться атаке «человек посередине». Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать предполагаемый статус изменений без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Create the user Foo with email address foo@bar.com in MyOrg
  community.general.pritunl_user:
    state: present
    organization: MyOrg
    user_name: Foo
    user_email: foo@bar.com
    user_mac_addresses:
      - "00:00:00:00:00:99"

- name: Disable the user Foo but keep it in Pritunl
  community.general.pritunl_user:
    state: present
    organization: MyOrg
    user_name: Foo
    user_email: foo@bar.com
    user_disabled: true

- name: Make sure the user Foo is not part of MyOrg anymore
  community.general.pritunl_user:
    state: absent
    organization: MyOrg
    user_name: Foo

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

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

Ключ	Описание
response словарь	Представление пользователей Pritunl в формате JSON. Возвращается: при успехе Пример: `{"audit": false, "auth_type": "google", "bypass_secondary": false, "client_to_client": false, "disabled": false, "dns_mapping": null, "dns_servers": null, "dns_suffix": null, "email": "foo@bar.com", "gravatar": true, "groups": ["foo", "bar"], "id": "5d070dafe63q3b2e6s472c3b", "name": "foo@acme.com", "network_links": [], "organization": "58070daee6sf342e6e4s2c36", "organization_name": "Acme", "otp_auth": true, "otp_secret": "35H5EJA3XB2$4CWG", "pin": false, "port_forwarding": [], "servers": []}`

Ключ

Описание

response

словарь

Представление пользователей Pritunl в формате JSON.

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

Пример: {"audit": false, "auth_type": "google", "bypass_secondary": false, "client_to_client": false, "disabled": false, "dns_mapping": null, "dns_servers": null, "dns_suffix": null, "email": "foo@bar.com", "gravatar": true, "groups": ["foo", "bar"], "id": "5d070dafe63q3b2e6s472c3b", "name": "foo@acme.com", "network_links": [], "organization": "58070daee6sf342e6e4s2c36", "organization_name": "Acme", "otp_auth": true, "otp_secret": "35H5EJA3XB2$4CWG", "pin": false, "port_forwarding": [], "servers": []}

Авторы

Florian Dambrine (@Lowess)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/pritunl_user_module.html