Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap — Настройка QoS IP приоритета/DSCP для FortiSwitch.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в playbook, укажите: fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap.

Новое в fortinet.fortimanager 2.0.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

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

adom

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

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

bypass_validation

логическое

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

Варианты:

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

enable_log

логическое

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

Варианты:

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

forticloud_access_token

строка

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

proposed_method

строка

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

Варианты:

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

rc_failed

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

Список кодов rc, по которым условия будут переопределены для отказа.

rc_succeeded

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

Список кодов rc, по которым условия будут переопределены для успеха.

state

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

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

Варианты:

  • "present"
  • "absent"

switchcontroller_qos_ipdscpmap

словарь

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

description

строка

Описание имени карты ip-dscp.

map

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

Карта.

cos-queue

целое число

Устаревшее, пожалуйста, переименуйте на cos_queue. Номер очереди COS.

diffserv

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

Дифференцированный сервис.

Варианты:

  • "CS0"
  • "CS1"
  • "AF11"
  • "AF12"
  • "AF13"
  • "CS2"
  • "AF21"
  • "AF22"
  • "AF23"
  • "CS3"
  • "AF31"
  • "AF32"
  • "AF33"
  • "CS4"
  • "AF41"
  • "AF42"
  • "AF43"
  • "CS5"
  • "EF"
  • "CS6"
  • "CS7"

ip-precedence

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

Устаревшее, пожалуйста, переименуйте на ip_precedence. IP Преемственность.

Варианты:

  • "network-control"
  • "internetwork-control"
  • "critic-ecp"
  • "flashoverride"
  • "flash"
  • "immediate"
  • "priority"
  • "routine"

name

строка

Имя записи отображения Dscp.

value

строка

Необработанные значения DSCP

name

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

Имя карты Dscp.

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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch QoS IP precedence/DSCP.
      fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_qos_ipdscpmap:
          description: <string>
          map:
            -
              cos_queue: <integer>
              diffserv:
                - CS0
                - CS1
                - AF11
                - AF12
                - AF13
                - CS2
                - AF21
                - AF22
                - AF23
                - CS3
                - AF31
                - AF32
                - AF33
                - CS4
                - AF41
                - AF42
                - AF43
                - CS5
                - EF
                - CS6
                - CS7
              ip_precedence:
                - network-control
                - internetwork-control
                - critic-ecp
                - flashoverride
                - flash
                - immediate
                - priority
                - routine
              name: <string>
              value: <string>
          name: <string>

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

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

Ключ

Описание

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

Spec-Zone.ru

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