fortinet.fortimanager.fmgr_hotspot20_h2qpoperatorname – Настройка дружественного имени оператора.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpoperatorname.
Новое в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для данных источников перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| hotspot20_h2qpoperatorname словарь | настройки верхнего уровня | |||
| name строка | Идентификатор дружественного имени. | |||
| value-list список / элементы=строка | нет описания | |||
| index целое число | Индекс значения. | |||
| lang строка | Код языка. | |||
| value строка | Значение дружественного имени. | |||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут нарушены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут выполнены | |||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | ||
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корень | |||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем | ||
Примечания
Примечание
- Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнить эту задачу.
- Для создания или обновления объекта используйте директиву present.
- Для удаления объекта используйте директиву 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: Configure operator friendly name.
fmgr_hotspot20_h2qpoperatorname:
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>
state: <value in [present, absent]>
hotspot20_h2qpoperatorname:
name: <value of string>
value-list:
-
index: <value of integer>
lang: <value of string>
value: <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_hotspot20_h2qpoperatorname_module.html
