fortinet.fortimanager.fmgr_dynamic_interface_dynamicmapping модуль – Динамическое отображение динамического интерфейса
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_dynamic_interface_dynamicmapping.
Добавлен в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
dynamic_interface_dynamicmapping словарь | Настройка параметров верхнего уровня. |
|
_scope список / элементы=словарь |
Область. |
|
name строка |
Имя. |
|
vdom строка |
Vdom. |
|
egress_shaping_profile любой |
(список или строка) Устарело, пожалуйста, переименуйте на egress_shaping_profile. Профиль формирования трафика на выходе. |
|
ingress_shaping_profile любой |
(список или строка) Устарело, пожалуйста, переименуйте на ingress_shaping_profile. Профиль формирования трафика на входе. |
|
intrazon_deny строка |
Устарело, пожалуйста, переименуйте на intrazone_deny. Запрет внутри зоны. Варианты:
|
|
local_intf любой |
(список) Устарело, пожалуйста, переименуйте на local_intf. Локальный интерфейс. |
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к forticloud API. |
interface строка / обязательно | Параметр (interface) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc кодов, с которыми будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список rc кодов, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Домен (adom), который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root. |
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: Dynamic interface dynamic mapping
fortinet.fortimanager.fmgr_dynamic_interface_dynamicmapping:
# 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>
interface: <your own value>
state: present # <value in [present, absent]>
dynamic_interface_dynamicmapping:
_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>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_dynamic_interface_dynamicmapping_module.html
