Модуль fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication_customcontrol_option – Параметр настройки приложения SaaS для профиля CASB брандмауэра
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication_customcontrol_option.
Новая функция в fortinet.fortimanager 2.3.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
casb-profile строка | Устарело, используйте «casb_profile» |
casb_profile строка | Параметр (casb-profile) в запрошенном URL. |
custom-control строка | Устарело, используйте «custom_control» |
custom_control строка | Параметр (custom-control) в запрошенном URL. |
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_casbprofile_saasapplication_customcontrol_option словарь | Настройка верхнего уровня параметров. |
|
name строка / обязательно |
Имя. |
|
user-input список / элементы=строка |
Устарело, переименуйте на user_input. Ввод пользователя. |
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, при которых условие будет считаться проваленным. |
rc_succeeded список / элементы=целое число | Список rc-кодов, при которых условие будет считаться выполненным. |
saas-application строка | Устарело, используйте «saas_application» |
saas_application строка | Параметр (saas-application) в запрошенном URL. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
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: Firewall casb profile saas application custom control option
fortinet.fortimanager.fmgr_firewall_casbprofile_saasapplication_customcontrol_option:
# 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>
casb_profile: <your own value>
saas_application: <your own value>
custom_control: <your own value>
state: present # <value in [present, absent]>
firewall_casbprofile_saasapplication_customcontrol_option:
name: <string>
user_input: <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_firewall_casbprofile_saasapplication_customcontrol_option_module.html
