Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension_downlinks module – Настройка интерфейса нисходящего канала FortiExtender для расширения LAN.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

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

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

bypass_validation

логический

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

Варианты:

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

enable_log

логический

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

Варианты:

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

extender-profile

строка

Устарел, используйте “extender_profile”

extender_profile

строка

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

extensioncontroller_extenderprofile_lanextension_downlinks

словарь

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

name

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

Имя записи конфигурации нисходящего канала расширения LAN FortiExtender.

port

строка

Порт нисходящего канала расширения LAN FortiExtender.

Варианты:

  • "port1"
  • "port2"
  • "port3"
  • "port4"
  • "port5"
  • "lan1"
  • "lan2"
  • "lan"

pvid

целое число

PVID нисходящего канала расширения LAN FortiExtender.

type

строка

Тип нисходящего канала расширения LAN FortiExtender [port/vap].

Варианты:

  • "port"
  • "vap"

vap

список / элементы=строка

VAP нисходящего канала расширения LAN FortiExtender.

vids

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

VID нисходящего канала расширения LAN FortiExtender.

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 или другие области, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Config FortiExtender downlink interface for LAN extension.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension_downlinks:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        state: present # <value in [present, absent]>
        extensioncontroller_extenderprofile_lanextension_downlinks:
          name: "your value" # Required variable, string
          # port: <value in [port1, port2, port3, ...]>
          # pvid: <integer>
          # type: <value in [port, vap]>
          # vap: <list or string>
          # vids: <list or integer>

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

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

Ключ

Описание

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

Spec-Zone.ru

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