Модуль community.general.pritunl_org — управление организациями 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.

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

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

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

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

Параметры

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

Атрибуты

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

Примеры

- name: Ensure the organization named MyOrg exists
  community.general.pritunl_org:
    state: present
    name: MyOrg

- name: Ensure the organization named MyOrg does not exist
  community.general.pritunl_org:
    state: absent
    name: MyOrg

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

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

Ключ	Описание
response словарь	Представление организации Pritunl в формате JSON. Возвращается: при успешном выполнении Пример: `{"auth_api": false, "auth_secret": null, "auth_token": null, "id": "csftwlu6uhralzi2dpmhekz3", "name": "Foo", "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_module.html