Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings — настройка интегрированных параметров FortiLink для FortiSwitch.

Примечание

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

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

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

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

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

revision_note

string

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

state

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

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

Варианты:

  • "present"
  • "absent"

switchcontroller_fortilinksettings

dictionary

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

access_vlan_mode

псевдонимы: access-vlan-mode

string

Поведение трафика внутри VLAN при потере соединения с FortiGate.

Варианты:

  • "legacy"
  • "fail-open"
  • "fail-close"

fortilink

string

Интерфейс FortiLink, к которому относятся эти параметры FortiLink.

inactive_timer

псевдонимы: inactive-timer

integer

Интервал времени

link_down_flush

псевдонимы: link-down-flush

string

Очистить данные NAC и динамических устройств на портах коммутатора при событии потери связи.

Варианты:

  • "disable"
  • "enable"

nac_ports

псевдонимы: nac-ports

dictionary

Порты NAC.

bounce_nac_port

псевдонимы: bounce-nac-port

string

Включить или отключить перезапуск порта

Варианты:

  • "disable"
  • "enable"

lan_segment

псевдонимы: lan-segment

string

Включить или отключить функцию сегмента LAN на интерфейсе FortiLink.

Варианты:

  • "disabled"
  • "enabled"

member_change

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

integer

Изменение участника.

nac_lan_interface

псевдонимы: nac-lan-interface

string

Настройка интерфейса NAC LAN.

nac_segment_vlans

псевдонимы: nac-segment-vlans

any

(список) Настройка VLAN сегмента NAC.

onboarding_vlan

псевдонимы: onboarding-vlan

string

VLAN адаптации NAC по умолчанию при обнаружении устройств NAC.

parent_key

псевдонимы: parent-key

string

Родительский ключ.

name

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

Имя параметров FortiLink.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другие значения, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку workspace.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
  • В этом модуле FortiManager поддерживается работа в режиме блокировки workspace. Для этого используются параметры верхнего уровня 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: Configure integrated FortiLink settings for FortiSwitch.
      fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_fortilinksettings:
          name: "your value" # Required variable, string
          # fortilink: <string>
          # inactive_timer: <integer>
          # link_down_flush: <value in [disable, enable]>
          # nac_ports:
          #   lan_segment: <value in [disabled, enabled]>
          #   member_change: <integer>
          #   nac_lan_interface: <string>
          #   nac_segment_vlans: <list or string>
          #   onboarding_vlan: <string>
          #   parent_key: <string>
          #   bounce_nac_port: <value in [disable, enable]>
          # access_vlan_mode: <value in [legacy, fail-open, fail-close]>

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

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

Ключ

Описание

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

Spec-Zone.ru

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