fortinet.fortimanager.fmgr_dynamic_address – без описания
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dynamic_address.
Новое в версии 2.10: модуль fortinet.fortimanager
Обзор
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров | ||
| dynamic_address словарь | параметры верхнего уровня | |||
| default строка | без описания | |||
| description строка | без описания | |||
| dynamic_addr_mapping список / элементы=строка | без описания | |||
| addr строка | без описания | |||
| id целое число | без описания | |||
| name строка | без описания | |||
| rc_failed список / элементы=строка | список кодов rc, при которых условие выполнения будет считаться неудачным | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условие выполнения будет считаться успешным | |||
| state строка / обязательный |
| направление для создания, обновления или удаления объекта | ||
| workspace_locking_adom строка | 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: no description
fmgr_dynamic_address:
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]>
dynamic_address:
default: <value of string>
description: <value of string>
dynamic_addr_mapping:
-
addr: <value of string>
id: <value of integer>
name: <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_dynamic_address_module.html
