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

Новая функция в community.general 2.5.0

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

Обзор

Модуль для отображения организаций Pritunl с использованием API Pritunl.

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать предсказание изменённого состояния без изменения целевого объекта.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	Вернёт подробности о том, что изменилось (или, возможно, должно измениться в `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}]

Авторы

Флориан Данбрин (@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_org_info_module.html