Модуль fortinet.fortimanager.fmgr_firewall_vipgrp64 — настройка групп виртуальных IP-адресов IPv6 для IPv4.

Примечание

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

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

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

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

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

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation логический	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Допустимые значения: `false` ← (по умолчанию) `true`
enable_log логический	Включить или отключить ведение журнала для задачи. Допустимые значения: `false` ← (по умолчанию) `true`
firewall_vipgrp64 словарь	Набор параметров верхнего уровня.
color целое число	Целочисленное значение, определяющее цвет значка в графическом интерфейсе
comments строка	Комментарий.
member любой тип	(список или строка) Объекты VIP — участники группы
name строка / обязательный	Имя группы VIP64.
uuid строка	Универсальный уникальный идентификатор
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Допустимые значения: `"update"` `"set"` `"add"`
rc_failed список / элементы — целые числа	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded список / элементы — целые числа	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state строка / обязательный	Указание на создание, обновление или удаление объекта. Допустимые значения: `"present"` `"absent"`
workspace_locking_adom строка	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие ADOM, включая 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.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код 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 IPv6 to IPv4 virtual IP groups.
      fortinet.fortimanager.fmgr_firewall_vipgrp64:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_vipgrp64:
          color: 2
          comments: "ansible-comment"
          member: "ansible-test-vip64"
          name: "ansible-test-vipgrp64"

- 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 to IPv4 virtual IP groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vipgrp64"
          params:
            adom: "ansible"
            vipgrp64: "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–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_vipgrp64_module.html