fortinet.fortimanager.fmgr_firewall_vipgrp – Настройка виртуальных IP-групп IPv4.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_firewall_vipgrp.
Введено в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логическое |
| устанавливать в True только при расхождениях между схемой модуля и структурой API FortiManager; модуль продолжает выполнение без проверки параметров | |||
| firewall_vipgrp словарь | настройка параметров верхнего уровня | ||||
| color целое число | Целое значение для определения цвета значка в графическом интерфейсе (от 1 до 32, по умолчанию 0, что устанавливает значение в 1). | ||||
| comments строка | Комментарий. | ||||
| dynamic_mapping список / элементы=строка | нет описания | ||||
| _scope список / элементы=строка | нет описания | ||||
| name строка | нет описания | ||||
| vdom строка | нет описания | ||||
| color целое число | нет описания | ||||
| comments строка | нет описания | ||||
| interface строка | нет описания | ||||
| member строка | нет описания | ||||
| uuid строка | Уникальный идентификатор (UUID; автоматически назначается, но может быть изменён вручную). | ||||
| interface строка | нет описания | ||||
| member строка | Объекты VIP группы (несколько объектов разделяются пробелом). | ||||
| name строка | Имя группы VIP. | ||||
| uuid строка | Уникальный идентификатор (UUID; автоматически назначается, но может быть изменён вручную). | ||||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |||
| workspace_locking_adom строка | adom для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой. | ||||
| 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: Configure IPv4 virtual IP groups.
fmgr_firewall_vipgrp:
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]>
firewall_vipgrp:
color: <value of integer>
comments: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
color: <value of integer>
comments: <value of string>
interface: <value of string>
member: <value of string>
uuid: <value of string>
interface: <value of string>
member: <value of string>
name: <value of string>
uuid: <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_firewall_vipgrp_module.html
