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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_addrgrp dictionary	Параметры верхнего уровня.
_image_base64 псевдонимы: _image-base64 string	Изображение в формате base64.
allow_routing псевдонимы: allow-routing string	Включить или отключить использование этой группы в конфигурации статической маршрутизации. Варианты: `"disable"` `"enable"`
category string	Категория группы адресов. Варианты: `"default"` `"ztna-ems-tag"` `"ztna-geo-tag"` `"telemetry"`
color integer	Цвет значка в графическом интерфейсе.
comment any	(dict или str) Комментарий.
dynamic_mapping list / элементы=dictionary	Динамическое сопоставление.
_image_base64 псевдонимы: _image-base64 string	Изображение в формате base64.
_scope list / элементы=dictionary	Область действия.
name string	Имя.
vdom string	VDOM.
allow_routing псевдонимы: allow-routing string	Разрешить маршрутизацию. Варианты: `"disable"` `"enable"`
category string	Категория группы адресов. Варианты: `"default"` `"ztna-ems-tag"` `"ztna-geo-tag"` `"telemetry"`
color integer	Цвет.
comment any	(dict или str) Комментарий.
exclude string	Исключение. Варианты: `"disable"` `"enable"`
exclude_member псевдонимы: exclude-member any	(list или str) Исключаемый участник.
fabric_object псевдонимы: fabric-object string	Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
global_object псевдонимы: global-object integer	Глобальный объект.
member list / элементы=string	Участник.
tags any	(list или str) Теги.
type string	Тип. Варианты: `"default"` `"array"` `"folder"`
uuid string	UUID.
visibility string	Видимость. Варианты: `"disable"` `"enable"`
exclude string	Включить или отключить исключение адресов. Варианты: `"disable"` `"enable"`
exclude_member псевдонимы: exclude-member any	(list или str) Участник исключения адресов.
fabric_object псевдонимы: fabric-object string	Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
global_object псевдонимы: global-object integer	Глобальный объект.
member list / элементы=string	Объекты адресов, входящие в группу.
name string / обязательный	Имя группы адресов.
tagging list / элементы=dictionary	Присвоение тегов.
category string	Категория тега.
name string	Имя записи тега.
tags any	(list) Теги.
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 / элементы=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются с использованием соглашения об именовании с подчеркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнять эту задачу.
Обычно выполнение одного модуля завершается ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_addrgrp_module.html