fortinet.fortimanager.fmgr_firewall_addrgrp модуль — Настройка групп адресов IPv4.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_addrgrp.

Новая функция в fortinet.fortimanager 1.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_addrgrp словарь	Установленные параметры верхнего уровня.
_image-base64 строка	Устаревшее, пожалуйста, переименуйте на _image_base64. Изображение base64.
allow-routing строка	Устаревшее, пожалуйста, переименуйте на allow_routing. Включить/выключить использование этой группы в конфигурации статических маршрутов. Варианты: `"disable"` `"enable"`
category строка	Категория группы адресов. Варианты: `"default"` `"ztna-ems-tag"` `"ztna-geo-tag"`
color целое число	Цвет значка на графическом интерфейсе.
comment любой тип	(словарь или строка) Комментарий.
dynamic_mapping список / элементы=словарь	Динамическое отображение.
_image_base64 строка	Устаревшее, пожалуйста, переименуйте на _image_base64. Изображение base64.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
allow_routing строка	Устаревшее, пожалуйста, переименуйте на allow_routing. Разрешить маршрутизацию. Варианты: `"disable"` `"enable"`
category строка	Категория группы адресов. Варианты: `"default"` `"ztna-ems-tag"` `"ztna-geo-tag"`
color целое число	Цвет.
comment любой тип	(словарь или строка) Комментарий.
exclude строка	Исключить. Варианты: `"disable"` `"enable"`
exclude_member любой тип	(список или строка) Устаревшее, пожалуйста, переименуйте на exclude_member. Исключение члена.
fabric_object строка	Устаревшее, пожалуйста, переименуйте на fabric_object. Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`

global-object integer	Устаревший, пожалуйста, переименуйте его в global_object. Глобальный объект.
member list / elements=string	Член.
tags any	(список или строка) Теги.
type string	Тип. Варианты: `"default"` `"array"` `"folder"`
uuid string	Uuid.
visibility string	Видимость. Варианты: `"disable"` `"enable"`
exclude string	Включить/выключить исключение адреса. Варианты: `"disable"` `"enable"`
exclude-member any	Устаревший, пожалуйста, переименуйте его в exclude_member. Член исключения адреса.
fabric-object string	Устаревший, пожалуйста, переименуйте его в fabric_object. Настройка глобального объекта безопасности Fabric. Варианты: `"disable"` `"enable"`
global-object integer	Устаревший, пожалуйста, переименуйте его в global_object. Глобальный объект.
member list / elements=string	Объекты адресов, содержащиеся в группе.
name string / обязательно	Имя группы адресов.
tagging list / elements=dictionary	Тегирование.
category string	Категория тегов.
name string	Имя записи тегирования.
tags any	(список) Теги.
tags string	Название
type string	Тип группы адресов. Варианты: `"default"` `"array"` `"folder"`
uuid string	Универсальный уникальный идентификатор
visibility string	Включить/выключить видимость адреса в графическом интерфейсе. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия для завершения с ошибкой.

rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут считаться выполненными.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы FortiManager в рабочем пространстве; значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Configure IPv4 address groups.
      fortinet.fortimanager.fmgr_firewall_addrgrp:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_addrgrp:
          allow-routing: disable
          color: 0
          member: "ansible-test1" # IPv4 address name
          name: "ansible-addrgrp4" # could not the same with other group, adress name, including IPv6 group and address
          visibility: disable

- 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 IPv4 address groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_addrgrp"
          params:
            adom: "ansible"
            addrgrp: "your_value"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборку

© 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_firewall_addrgrp_module.html