Модуль fortinet.fortimanager.fmgr_user_group_guest — Гостевой пользователь.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_user_group_guest.
Новое в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
group строка / обязательно | Параметр (group) в запрошенном URL. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список rc-кодов, с которыми будут переопределены условия завершения с ошибкой. |
rc_succeeded список / элементы=целое | Список rc-кодов, с которыми будут переопределены условия успешного завершения. |
state строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
user_group_guest словарь | Набор параметров верхнего уровня. |
|
comment строка |
Комментарий. |
|
company строка |
Установить действие для поля гостевого пользователя компании. |
|
строка |
Электронная почта. |
|
expiration строка |
Время истечения. |
|
group строка |
Имя гостя. |
|
id целое |
ID гостя. |
|
mobile_phone строка |
Устарело, пожалуйста, переименуйте в mobile_phone. Мобильный телефон. |
|
name строка |
Имя гостя. |
|
password любой |
(список) Пароль гостя. |
|
sponsor строка |
Установить действие для поля спонсора гостевого пользователя. |
|
user_id строка / обязательно |
Устарело, пожалуйста, переименуйте в user_id. ID гостя. |
workspace_locking_adom строка | Adom для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют соглашение об именовании с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но вы получите предупреждения о устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в файле ansible.cfg.
- Режим блокировки рабочего пространства поддерживается в данном модуле FortiManager. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается код rc, отличный от нуля. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Guest User.
fortinet.fortimanager.fmgr_user_group_guest:
bypass_validation: false
adom: FortiCarrier
group: ansible-test-group # name
state: present
user_group_guest:
comment: ansible-comment
email: test@fortinet.com
name: ansible-test-guest
password: fortinet
user-id: Email
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the guest users
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_group_guest" # Note: this session will been shown only if the Type parameter in User Grup is 'GUEST'
params:
adom: "FortiCarrier"
group: "ansible-test-group" # name
guest: "your_value"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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/fortinet/fortimanager/fmgr_user_group_guest_module.html
