Модуль community.general.pritunl_user_info – Список пользователей Pritunl с помощью API Pritunl

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.pritunl_user_info.

Новое в community.general 2.3.0

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

Описание

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

Параметры

Параметр	Комментарии
organization алиасы: org строка / обязательный	Название организации, к которой принадлежит пользователь.
pritunl_api_secret строка / обязательный	Секрет API, найденный в Администраторы > ИМЯ_ПОЛЬЗОВАТЕЛЯ > Секрет API.
pritunl_api_token строка / обязательный	Токен API пользователя-администратора Pritunl. Он должен быть включен в Администраторы > ИМЯ_ПОЛЬЗОВАТЕЛЯ > Включить аутентификацию по токену.
pritunl_url строка / обязательный	URL и порт сервера Pritunl, на котором включен API.
user_name строка	Имя пользователя для фильтрации в Pritunl.
user_type строка	Тип пользователя `user_name`. Варианты: `"client"` ← (по умолчанию) `"server"`
validate_certs булево	Нужно ли проверять сертификаты. Этого значения никогда не следует устанавливать в `false`, кроме случаев, когда вы уверены, что подключение к серверу не подвержено атаке «человек посередине». Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: List all existing users part of the organization MyOrg
  community.general.pritunl_user_info:
    state: list
    organization: MyOrg

- name: Search for the user named Florian part of the organization MyOrg
  community.general.pritunl_user_info:
    state: list
    organization: MyOrg
    user_name: Florian

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

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

Ключ	Описание
users список / элементы=словарь	Список пользователей Pritunl. Возвращаемое значение: успех Пример: `[{"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": []}]`

Ключ

Описание

users

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

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

Возвращаемое значение: успех

Пример: [{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/pritunl_user_info_module.html