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

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_addrgrp6.

Добавлена в fortinet.fortimanager 1.0.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_addrgrp6 dictionary	Набор параметров верхнего уровня.
_image-base64 string	Устарело, переименуйте в _image_base64. Base64 изображение.
color integer	Целочисленное значение для определения цвета значка в графическом интерфейсе.
comment string	Комментарий.
dynamic_mapping list / elements=dictionary	Динамическое сопоставление.
_image-base64 string	Устарело, переименуйте в _image_base64. Base64 изображение.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
color integer	Цвет.
comment string	Комментарий.
exclude string	Включить/выключить исключение address6. Варианты: `"disable"` `"enable"`
exclude-member any	(list) Устарело, переименуйте в exclude_member. Член исключения address6.
fabric-object string	Устарело, переименуйте в fabric_object. Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
global-object integer	Устарело, переименуйте в global_object. Глобальный объект.
member any	(list or str) Член.
tags any	(list or str) Теги.
uuid string	Uuid.
visibility string	Видимость. Варианты: `"disable"` `"enable"`

exclude string	Включить/отключить исключение address6. Варианты: `"disable"` `"enable"`
exclude-member any	(list) Устарело, переименуйте в exclude_member. Элемент исключения Address6.
fabric-object string	Устарело, переименуйте в fabric_object. Настройка глобального объекта Security Fabric. Варианты: `"disable"` `"enable"`
global-object integer	Устарело, переименуйте в global_object. Глобальный объект.
member any	(list or str) Объекты адресов, содержащиеся в группе.
name string / required	Имя группы адресов IPv6.
tagging list / elements=dictionary	Разметка.
category string	Категория тега.
name string	Имя записи разметки.
tags any	(list) Теги.
tags string	Имена тегов объектов, применённых к адресу.
uuid string	Универсальный уникальный идентификатор
visibility string	Включить/отключить видимость группы адресов6 в графическом интерфейсе. Варианты: `"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 list / elements=integer	Список кодов rc, с которыми будут переопределены условия успеха.
state string / required	Директива для создания, обновления или удаления объекта. Варианты: `"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 помогают в этом.
Для создания или обновления объекта используйте директиву 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 IPv6 address groups.
      fortinet.fortimanager.fmgr_firewall_addrgrp6:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_addrgrp6:
          color: 0
          comment: "ansible-comment"
          member: "ansible-test" # IPv6 address name
          name: "ansible-addrgrp6" # could not the same with other group, adress name, including IPv4 group and address
          visibility: enable

- 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 IPv6 address groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_addrgrp6"
          params:
            adom: "ansible"
            addrgrp6: "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_addrgrp6_module.html