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

Впервые в community.general 2.5.0

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

Описание

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

Параметры

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

Атрибуты

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

Примеры

- 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 словарь	JSON-представление организации Pritunl. Возвращается: успех Пример: `{"auth_api": false, "auth_secret": null, "auth_token": null, "id": "csftwlu6uhralzi2dpmhekz3", "name": "Foo", "user_count": 0}`

Авторы

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