Модуль community.general.pritunl_user – Управление пользователями Pritunl с использованием API Pritunl

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в playbook, укажите: community.general.pritunl_user.

Новое в community.general 2.3.0

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

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

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

Параметры

Параметр	Комментарии
organization aliases: org string / required	Имя организации, частью которой является пользователь.
pritunl_api_secret string / required	Секретный ключ API, находящийся в разделе Администраторы > ИМЯ_ПОЛЬЗОВАТЕЛЯ > Секретный ключ API.
pritunl_api_token string / required	Токен API пользователя-администратора Pritunl. Его необходимо включить в разделе Администраторы > ИМЯ_ПОЛЬЗОВАТЕЛЯ > Включить проверку подлинности по токену.
pritunl_url string / required	URL и порт сервера Pritunl, на котором включен API.
state string	Если `present`, модуль добавляет пользователя `user_name` в `organization` Pritunl. Если `absent`, удаляет пользователя `user_name` из `organization` Pritunl. Варианты: `"present"` ← (по умолчанию) `"absent"`
user_disabled boolean	Включить/Выключить пользователя `user_name`. Варианты: `false` `true`
user_email string	Адрес электронной почты, связанный с пользователем `user_name`.
user_gravatar boolean	Включить/Выключить использование Gravatar для пользователя `user_name`. Варианты: `false` `true`
user_groups list / elements=string	Список групп, связанных с пользователем `user_name`.
user_mac_addresses list / elements=string добавлено в community.general 5.0.0	Разрешённые MAC-адреса для пользователя `user_name`.
user_name string / required	Имя пользователя, которого нужно создать или удалить из Pritunl.
user_type string	Тип пользователя `user_name`. Варианты: `"client"` ← (по умолчанию) `"server"`
validate_certs boolean	Необходимо ли проверять сертификаты. Это значение никогда не должно быть установлено в `false`, за исключением случаев, когда вы абсолютно уверены, что ваше соединение с сервером не может быть подвержено атаке «человек посередине». Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create the user Foo with email address foo@bar.com in MyOrg
  community.general.pritunl_user:
    state: present
    organization: MyOrg
    user_name: Foo
    user_email: foo@bar.com
    user_mac_addresses:
      - "00:00:00:00:00:99"

- name: Disable the user Foo but keep it in Pritunl
  community.general.pritunl_user:
    state: present
    organization: MyOrg
    user_name: Foo
    user_email: foo@bar.com
    user_disabled: true

- name: Make sure the user Foo is not part of MyOrg anymore
  community.general.pritunl_user:
    state: absent
    organization: MyOrg
    user_name: Foo

Значения возврата

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

Ключ	Описание
response словарь	JSON-представление пользователей 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": []}`

Ключ

Описание

response

словарь

JSON-представление пользователей 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/pritunl_user_module.html