модуль community.general.pritunl_org_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_org_info.

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

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

Краткое описание

Модуль для вывода списка организаций Pritunl с помощью API Pritunl.

Параметры

Параметр	Комментарии
organization псевдонимы: org строка	Имя организации Pritunl для поиска. Если не указано, модуль возвращает все организации Pritunl.
pritunl_api_secret строка / обязательный	Секретный ключ API, указанный в разделе Administrators > USERNAME > API Secret.
pritunl_api_token строка / обязательный	Токен API пользователя-администратора Pritunl. Его необходимо включить в разделе Administrators > USERNAME > Enable Token Authentication.
pritunl_url строка / обязательный	URL и порт сервера Pritunl, на котором включён API.
validate_certs логическое значение	Проверять сертификаты или нет. Не следует устанавливать это значение в `false`, кроме случаев, когда вы полностью уверены, что соединение с сервером не подвержено атаке «человек посередине». Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: List all existing Pritunl organizations
  community.general.pritunl_org_info:

- name: Search for an organization named MyOrg
  community.general.pritunl_user_info:
    organization: MyOrg

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

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

Ключ	Описание
organizations список / элементы=словарь	Список организаций Pritunl. Возвращается: при успешном выполнении Пример: `[{"auth_api": false, "auth_secret": null, "auth_token": null, "id": "csftwlu6uhralzi2dpmhekz3", "name": "FooOrg", "user_count": 0}, {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "58070daee63f3b2e6e472c36", "name": "MyOrg", "user_count": 3}, {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "v1sncsxxybnsylc8gpqg85pg", "name": "BarOrg", "user_count": 0}]`

Ключ

Описание

organizations

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

Список организаций Pritunl.

Возвращается: при успешном выполнении

Пример: [{"auth_api": false, "auth_secret": null, "auth_token": null, "id": "csftwlu6uhralzi2dpmhekz3", "name": "FooOrg", "user_count": 0}, {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "58070daee63f3b2e6e472c36", "name": "MyOrg", "user_count": 3}, {"auth_api": false, "auth_secret": null, "auth_token": null, "id": "v1sncsxxybnsylc8gpqg85pg", "name": "BarOrg", "user_count": 0}]

Авторы

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_org_info_module.html