Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_dynamic_interface — динамический интерфейс

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

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

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

bypass_validation

boolean

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

Допустимые значения:

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

dynamic_interface

dictionary

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

color

integer

Цвет.

default_mapping

псевдонимы: default-mapping

string

Сопоставление по умолчанию.

Допустимые значения:

  • "disable"
  • "enable"

defmap_intf

псевдонимы: defmap-intf

string

Интерфейс сопоставления по умолчанию.

defmap_intrazone_deny

псевдонимы: defmap-intrazone-deny

string

Запрет взаимодействия внутри зоны для сопоставления по умолчанию.

Допустимые значения:

  • "disable"
  • "enable"

defmap_zonemember

псевдонимы: defmap-zonemember

any

(список) Участник зоны сопоставления по умолчанию.

description

string

Описание.

dynamic_mapping

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

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

_scope

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

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

name

string

Имя.

vdom

string

VDOM.

egress_shaping_profile

псевдонимы: egress-shaping-profile

any

(список или строка) Профиль формирования исходящего трафика.

ingress_shaping_profile

псевдонимы: ingress-shaping-profile

any

(список или строка) Профиль формирования входящего трафика.

intrazone_deny

псевдонимы: intrazone-deny

string

Запрет взаимодействия внутри зоны.

Допустимые значения:

  • "disable"
  • "enable"

local_intf

псевдонимы: local-intf

any

(список) Локальный интерфейс.

egress_shaping_profile

псевдонимы: egress-shaping-profile

any

(список или строка) Профиль формирования исходящего трафика.

ingress_shaping_profile

псевдонимы: ingress-shaping-profile

any

(список или строка) Профиль формирования входящего трафика.

name

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

Имя.

platform_mapping

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

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

egress_shaping_profile

псевдонимы: egress-shaping-profile

any

(список или строка) Профиль формирования исходящего трафика.

ingress_shaping_profile

псевдонимы: ingress-shaping-profile

any

(список или строка) Профиль формирования входящего трафика.

intf_zone

псевдонимы: intf-zone

string

Зона интерфейса.

intrazone_deny

псевдонимы: intrazone-deny

string

Запрет взаимодействия внутри зоны.

Допустимые значения:

  • "disable"
  • "enable"

name

string

Имя.

single_intf

псевдонимы: single-intf

string

Одиночный интерфейс.

Допустимые значения:

  • "disable"
  • "enable"

wildcard

string

Шаблон подстановки.

Допустимые значения:

  • "disable"
  • "enable"

wildcard_intf

псевдонимы: wildcard-intf

string

Интерфейс с шаблоном подстановки.

zone_only

псевдонимы: zone-only

string

Только зона.

Допустимые значения:

  • "disable"
  • "enable"

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"

workspace_locking_adom

string

ADOM, который нужно заблокировать в FortiManager, работающем в режиме рабочей области. В качестве значения можно указать global, а также другие значения, включая 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: Dynamic interface
      fortinet.fortimanager.fmgr_dynamic_interface:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        dynamic_interface:
          name: "your value" # Required variable, string
          # color: <integer>
          # default_mapping: <value in [disable, enable]>
          # defmap_intf: <string>
          # defmap_intrazone_deny: <value in [disable, enable]>
          # defmap_zonemember: <list or string>
          # description: <string>
          # dynamic_mapping:
          #   - _scope:
          #       - name: <string>
          #         vdom: <string>
          #     egress_shaping_profile: <list or string>
          #     intrazone_deny: <value in [disable, enable]>
          #     local_intf: <list or string>
          #     ingress_shaping_profile: <list or string>
          # egress_shaping_profile: <list or string>
          # single_intf: <value in [disable, enable]>
          # ingress_shaping_profile: <list or string>
          # platform_mapping:
          #   - egress_shaping_profile: <list or string>
          #     ingress_shaping_profile: <list or string>
          #     intf_zone: <string>
          #     intrazone_deny: <value in [disable, enable]>
          #     name: <string>
          # wildcard: <value in [disable, enable]>
          # wildcard_intf: <string>
          # zone_only: <value in [disable, enable]>

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

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

Ключ

Описание

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

Spec-Zone.ru

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