fortinet.fortimanager.fmgr_switchcontroller_trafficpolicy модуль — Настройка политики трафика FortiSwitch.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_switchcontroller_trafficpolicy.
Новое в fortinet.fortimanager 2.2.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, по которым условия выполнения будут переопределены в случае ошибки. |
rc_succeeded список / элементы=целое число | Список rc-кодов, по которым условия выполнения будут переопределены в случае успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
switchcontroller_trafficpolicy словарь | Настройка параметров верхнего уровня. |
|
cos-queue целое число |
Устарело, пожалуйста, переименуйте на cos_queue. Очередь COS. |
|
description строка |
Описание политики трафика. |
|
guaranteed-bandwidth целое число |
Устарело, пожалуйста, переименуйте на guaranteed_bandwidth. Гарантированная пропускная способность в кбит/с. |
|
guaranteed-burst целое число |
Устарело, пожалуйста, переименуйте на guaranteed_burst. Гарантированный размер всплеска в байтах. |
|
id целое число / обязательно |
ID политика FSW. |
|
maximum-burst целое число |
Устарело, пожалуйста, переименуйте на maximum_burst. Максимальный размер всплеска в байтах. |
|
name строка |
Название политики трафика. |
|
policer-status строка |
Устарело, пожалуйста, переименуйте на policer_status. Включить/выключить конфигурацию политика на политике трафика. Варианты:
|
|
type строка |
Тип. Варианты:
|
workspace_locking_adom строка | 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: Configure FortiSwitch traffic policy.
fortinet.fortimanager.fmgr_switchcontroller_trafficpolicy:
# 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_trafficpolicy:
cos_queue: <integer>
description: <string>
guaranteed_bandwidth: <integer>
guaranteed_burst: <integer>
id: <integer>
maximum_burst: <integer>
name: <string>
policer_status: <value in [disable, enable]>
type: <value in [ingress, egress]>
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_trafficpolicy_module.html
