Spec-Zone.ru › Ansible

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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.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_vip46

dictionary

Набор параметров верхнего уровня.

arp_reply

aliases: arp-reply

string

Включить ответ ARP.

Варианты:

  • "disable"
  • "enable"

color

integer

Цвет значка в графическом интерфейсе.

comment

string

Комментарий.

dynamic_mapping

list / elements=dictionary

Динамическое сопоставление.

_scope

list / elements=dictionary

Область действия.

name

string

Имя.

vdom

string

VDOM.

arp_reply

aliases: arp-reply

string

Ответ ARP.

Варианты:

  • "disable"
  • "enable"

color

integer

Цвет.

comment

string

Комментарий.

extip

string

Внешний IP-адрес.

extport

string

Внешний порт.

id

integer

Идентификатор.

ldb_method

aliases: ldb-method

string

Метод балансировки нагрузки.

Варианты:

  • "static"
  • "round-robin"
  • "weighted"
  • "least-session"
  • "least-rtt"
  • "first-alive"

mappedip

string

Сопоставленный IP-адрес.

mappedport

string

Сопоставленный порт.

monitor

any

(список или строка) Монитор.

portforward

string

Переадресация портов.

Варианты:

  • "disable"
  • "enable"

protocol

string

Протокол.

Варианты:

  • "tcp"
  • "udp"

server_type

aliases: server-type

string

Тип сервера.

Варианты:

  • "http"
  • "tcp"
  • "udp"
  • "ip"

src_filter

aliases: src-filter

any

(список) Фильтр источника.

srcintf_filter

aliases: srcintf-filter

any

(список или строка) Интерфейсы, к которым применяется VIP46.

type

string

Тип.

Варианты:

  • "static-nat"
  • "server-load-balance"

uuid

string

UUID.

extip

string

Начальный внешний IP-адрес [-конечный внешний IP-адрес].

extport

string

Порт внешней службы.

id

integer

Пользовательский идентификатор.

ldb_method

aliases: ldb-method

string

Метод балансировки нагрузки.

Варианты:

  • "static"
  • "round-robin"
  • "weighted"
  • "least-session"
  • "least-rtt"
  • "first-alive"

mappedip

string

Начальный сопоставленный IP-адрес [-конечный сопоставленный IP-адрес].

mappedport

string

Сопоставленный порт службы.

monitor

any

(список или строка) Мониторы работоспособности.

name

string / обязательно

Имя VIP46.

portforward

string

Включить переадресацию портов.

Варианты:

  • "disable"
  • "enable"

protocol

string

Протокол сопоставленного порта.

Варианты:

  • "tcp"
  • "udp"

realservers

list / elements=dictionary

Реальные серверы.

client_ip

aliases: client-ip

string

Ограничить доступ к серверу клиентским IP-адресом из этого диапазона.

healthcheck

string

Проверка работоспособности каждого сервера.

Варианты:

  • "disable"
  • "enable"
  • "vip"

holddown_interval

aliases: holddown-interval

integer

Интервал удержания.

id

integer

Идентификатор реального сервера.

ip

string

Сопоставленный IPv6-адрес сервера.

max_connections

aliases: max-connections

integer

Максимальное количество подключений к серверу.

monitor

any

(список или строка) Мониторы работоспособности.

port

integer

Порт сопоставленного сервера.

status

string

Административный статус сервера.

Варианты:

  • "active"
  • "standby"
  • "disable"

weight

integer

Вес.

server_type

aliases: server-type

string

Тип сервера.

Варианты:

  • "http"
  • "tcp"
  • "udp"
  • "ip"

src_filter

aliases: src-filter

any

(список) Фильтр IP-адресов источника

srcintf_filter

aliases: srcintf-filter

any

(список или строка) Интерфейсы, к которым применяется VIP46.

type

string

Тип VIP

Варианты:

  • "static-nat"
  • "server-load-balance"

uuid

string

Универсальный уникальный идентификатор

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, для которых переопределяются условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательно

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме рабочего пространства. Значением может быть global или другие ADOM, включая 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 to IPv6 virtual IPs.
      fortinet.fortimanager.fmgr_firewall_vip46:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_vip46:
          arp_reply: enable
          color: 1
          comment: "ansible-comment"
          id: 1
          ldb_method: static # <value in [static, round-robin, weighted, ...]>
          name: "ansible-test-vip46"
          protocol: tcp # <value in [tcp, udp]>

- 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 to IPv6 virtual IPs
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_vip46"
          params:
            adom: "ansible"
            vip46: "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_vip46_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API