fortinet.fortimanager.fmgr_user_group_guest – Пользователь гостевой группы.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_user_group_guest.
Добавлено в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| group строка / обязательно | параметр (group) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, с помощью которых будут переопределяться условия отказа | ||
| rc_succeeded список / элементы=строка | список кодов rc, с помощью которых будут переопределяться условия успеха | ||
| state строка / обязательно |
| инструкция для создания, обновления или удаления объекта | |
| user_group_guest словарь | настройка параметров верхнего уровня | ||
| comment строка | Комментарий. | ||
| company строка | Установить действие для поля company гостевого пользователя. | ||
| email строка | Электронная почта. | ||
| expiration строка | Время истечения срока действия. | ||
| mobile-phone строка | Мобильный телефон. | ||
| name строка | Имя гостя. | ||
| password строка | нет описания | ||
| sponsor строка | Установить действие для поля спонсора гостевого пользователя. | ||
| user-id строка | Идентификатор гостя. | ||
| workspace_locking_adom строка | область, которая должна быть заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство | |
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код rc. Вы также можете переопределить условия отказа или успеха с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Guest User.
fmgr_user_group_guest:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
group: <your own value>
state: <value in [present, absent]>
user_group_guest:
comment: <value of string>
company: <value of string>
email: <value of string>
expiration: <value of string>
mobile-phone: <value of string>
name: <value of string>
password: <value of string>
sponsor: <value of string>
user-id: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны в этом месте, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запросённый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_user_group_guest_module.html
