Модуль fortinet.fortimanager.fmgr_system_npu_dswqueuedtsprofile – Настройка профиля очереди NPU DSW DTS.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге команд, укажите: fortinet.fortimanager.fmgr_system_npu_dswqueuedtsprofile.
Новое в 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 строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
system_npu_dswqueuedtsprofile словарь | Установленные параметры верхнего уровня. |
| iport строка | Установить NPU DSW DTS в порт. Варианты:
|
| name строка / обязательно | Название. |
|
oport string |
Установите выходной порт NPU DSW DTS. Выбор:
|
|
profile-id integer |
Устарело, пожалуйста, переименуйте его в profile_id. Установите идентификатор профиля NPU DSW DTS. |
|
queue-select integer |
Устарело, пожалуйста, переименуйте его в queue_select. Установите выбранный идентификатор очереди NPU DSW DTS. |
workspace_locking_adom string | ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корень. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 NPU DSW Queue DTS profile.
fortinet.fortimanager.fmgr_system_npu_dswqueuedtsprofile:
# 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]>
system_npu_dswqueuedtsprofile:
iport: <value in [EIF0, eif0, EIF1, ...]>
name: <string>
oport: <value in [EIF0, eif0, EIF1, ...]>
profile_id: <integer>
queue_select: <integer>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
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_system_npu_dswqueuedtsprofile_module.html
