Модуль fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap_map — Сопоставляет значение IP-DSCP с очередью COS.
Примечание
Этот модуль входит в коллекцию 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_map.
Добавлен в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логический тип | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логический тип | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
ip-dscp-map строка | Устарело, используйте “ip_dscp_map” |
ip_dscp_map строка | Параметр (ip-dscp-map) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для завершения задачи с ошибкой. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успешного завершения задачи. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
switchcontroller_qos_ipdscpmap_map словарь | Набор параметров верхнего уровня. |
|
cos_queue целое число |
Устарело, переименуйте на cos_queue. Номер очереди COS. |
|
diffserv список / элементы=строка |
Разграниченный сервис. Варианты:
|
|
ip_precedence список / элементы=строка |
Устарело, переименуйте на ip_precedence. Приоритет IP. Варианты:
|
|
name строка / обязательно |
Имя записи сопоставления DSCP. |
|
value строка |
Необработанные значения DSCP |
workspace_locking_adom строка | Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Maps between IP-DSCP value to COS queue.
fortinet.fortimanager.fmgr_switchcontroller_qos_ipdscpmap_map:
# 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>
ip_dscp_map: <your own value>
state: present # <value in [present, absent]>
switchcontroller_qos_ipdscpmap_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>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на коллекцию
© 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_map_module.html