Модуль community.general.pritunl_user_info — список пользователей 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_info.

Добавлено в 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.
user_name строка	Имя пользователя для фильтрации в Pritunl.
user_type строка	Тип пользователя `user_name`. Варианты: `"client"` ← (по умолчанию) `"server"`
validate_certs логическое значение	Нужно ли проверять сертификаты. Не следует устанавливать значение `false`, если только вы не уверены, что соединение с сервером защищено от атак типа «человек посередине». Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- 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–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_info_module.html