Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (default)
  • true

enable_log

boolean

Включить/Выключить ведение журнала для задачи.

Варианты:

  • false ← (default)
  • true

firewall_vip46

dictionary

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

arp-reply

string

Устарело, переименуйте в arp_reply. Включить ответ ARP.

Варианты:

  • "disable"
  • "enable"

color

integer

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

comment

string

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

dynamic_mapping

list / elements=dictionary

Динамическое отображение.

_scope

list / elements=dictionary

Область видимости.

name

string

Имя.

vdom

string

Vdom.

arp-reply

string

Устарело, переименуйте в arp_reply. Ответ ARP.

Варианты:

  • "disable"
  • "enable"

color

integer

Цвет.

comment

string

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

extip

string

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

extport

string

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

id

integer

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

ldb-method

string

Устарело, переименуйте в ldb_method. Метод LDB.

Варианты:

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

mappedip

string

Отображаемый IP-адрес.

mappedport

string

Отображаемый порт.

monitor

any

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

portforward

string

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

Варианты:

  • "disable"
  • "enable"

protocol

string

Протокол.

Choices:

  • "tcp"
  • "udp"

server-type

string

Устарело, переименуйте в server_type. Тип сервера.

Choices:

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

src-filter

any

(список) Устарело, переименуйте в src_filter. Фильтр источника.

srcintf-filter

any

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

type

string

Тип.

Choices:

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

uuid

string

Uuid.

extip

string

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

extport

string

Внешний порт сервиса.

id

integer

Пользовательский ID.

ldb-method

string

Устарело, переименуйте в ldb_method. Метод балансировки нагрузки.

Choices:

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

mappedip

string

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

mappedport

string

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

monitor

any

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

name

string / required

Имя VIP46.

portforward

string

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

Choices:

  • "disable"
  • "enable"

protocol

string

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

Choices:

  • "tcp"
  • "udp"

realservers

list / elements=dictionary

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

client-ip

string

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

healthcheck

string

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

Choices:

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

holddown-interval

integer

Устарело, переименуйте в holddown_interval. Интервал удержания.

id

integer

ID реального сервера.

ip

string

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

max-connections

integer

Устарело, переименуйте в max_connections. Максимальное количество соединений, разрешенных для сервера.

monitor

any

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

port

целое число

Порт сервера.

status

строка

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

Варианты:

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

weight

целое число

Вес.

server-type

строка

Устарело, пожалуйста, переименуйте на server_type. Тип сервера.

Варианты:

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

src-filter

any

(список) Устарело, пожалуйста, переименуйте на src_filter. Фильтр IP-адресов источника

srcintf-filter

any

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

type

строка

Тип VIP

Варианты:

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

uuid

строка

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

forticloud_access_token

строка

Авторизуйте Ansible-клиент с токеном доступа к API forticloud.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, при которых будет происходить отказ.

rc_succeeded

список / элементы=целое число

Список кодов rc, при которых будет происходить успех.

state

строка / обязательно

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

ADOM для блокировки в режиме работы FortiManager в пространстве работы, значение может быть глобальным и другими, включая корень.

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 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

словарь

Результат запроса.

Возвращается: всегда

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_vip46_module.html

Spec-Zone.ru

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