Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_members — интерфейсы FortiGate, добавленные в SD-WAN.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

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

bypass_validation

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

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

state

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

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

Варианты:

  • "present"
  • "absent"

wanprof

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

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

wanprof_system_sdwan_members

dictionary

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

_dynamic_member

псевдонимы: _dynamic-member

string

Динамический участник.

comment

string

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

cost

integer

Стоимость этого интерфейса для служб в режиме SLA

gateway

string

Шлюз по умолчанию для этого интерфейса.

gateway6

string

Шлюз IPv6.

ingress_spillover_threshold

псевдонимы: ingress-spillover-threshold

integer

Порог входящего трафика для переключения этого интерфейса

interface

string

Имя интерфейса.

preferred_source

псевдонимы: preferred-source

string

Предпочитаемый источник маршрута для этого участника.

priority

integer

Приоритет интерфейса

priority6

integer

Приоритет интерфейса для IPv6

priority_in_sla

псевдонимы: priority-in-sla

integer

Предпочитаемый приоритет маршрутов к этому участнику, когда он соответствует SLA

priority_out_sla

псевдонимы: priority-out-sla

integer

Предпочитаемый приоритет маршрутов к этому участнику, когда он не соответствует SLA

seq_num

псевдонимы: seq-num

integer / обязательный

Порядковый номер

source

string

Исходный IP-адрес, используемый в пакете проверки работоспособности, отправляемом серверу.

source6

string

Исходный IPv6-адрес, используемый в пакете проверки работоспособности, отправляемом серверу.

spillover_threshold

псевдонимы: spillover-threshold

integer

Порог исходящего трафика для переключения этого интерфейса

status

string

Включить/отключить этот интерфейс в SD-WAN.

Варианты:

  • "disable"
  • "enable"

transport_group

псевдонимы: transport-group

integer

Измеренная транспортная группа

volume_ratio

псевдонимы: volume-ratio

integer

Измеренное соотношение объемов

weight

integer

Вес этого интерфейса при балансировке нагрузки с учетом веса.

zone

string

Имя зоны.

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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: FortiGate interfaces added to the SD-WAN.
      fortinet.fortimanager.fmgr_wanprof_system_sdwan_members:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_sdwan_members:
          seq_num: 0 # Required variable, integer
          # _dynamic_member: <string>
          # comment: <string>
          # cost: <integer>
          # gateway: <string>
          # gateway6: <string>
          # ingress_spillover_threshold: <integer>
          # interface: <string>
          # priority: <integer>
          # source: <string>
          # source6: <string>
          # spillover_threshold: <integer>
          # status: <value in [disable, enable]>
          # volume_ratio: <integer>
          # weight: <integer>
          # zone: <string>
          # priority6: <integer>
          # preferred_source: <string>
          # transport_group: <integer>
          # priority_in_sla: <integer>
          # priority_out_sla: <integer>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

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

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Состояние запроса API.

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

Пример: 0

response_data

list / элементы=string

Ответ API.

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

response_message

string

Текстовое описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Состояние запроса.

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

Пример: 0

version_check_warning

list / элементы=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_wanprof_system_sdwan_members_module.html

Spec-Zone.ru

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