Модуль fortinet.fortimanager.fmgr_firewall_proxyaddress_headergroup – группа HTTP-заголовков.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_proxyaddress_headergroup.
Новая функция в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Возможные значения:
|
enable_log логическое значение | Включить/отключить ведение журнала для задачи. Возможные значения:
|
firewall_proxyaddress_headergroup словарь | Установленные параметры верхнего уровня. |
|
case_sensitivity строка |
Устарело, пожалуйста, переименуйте на case_sensitivity. Регистрозависимость в шаблоне. Возможные значения:
|
|
header строка |
Регулярное выражение HTTP-заголовка. |
|
header_name строка |
Устарело, пожалуйста, переименуйте на header_name. HTTP-заголовок. |
|
id целое число / обязательно |
Идентификатор. |
forticloud_access_token строка | Авторизовать клиент Ansible с помощью маркера доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Возможные значения:
|
proxy_address строка | Параметр (proxy-address) в запрошенном URL. |
proxy_address строка | Параметр (proxy-address) в запрошенном URL. |
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Возможные значения:
|
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_failed и rc_succeeded
Примеры
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: HTTP header group.
fortinet.fortimanager.fmgr_firewall_proxyaddress_headergroup:
bypass_validation: false
adom: ansible
proxy-address: "ansible-test" # name
state: present
firewall_proxyaddress_headergroup: # available only when type is set to "Advanced(Source)" in prox-address
case-sensitivity: disable
header: ansible-test-header
header-name: ansible-test-header
id: 1
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the HTTP header groups of proxy address
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_proxyaddress_headergroup" # available only when type is set to "Advanced(Source)" in prox-address
params:
adom: "ansible"
proxy-address: "ansible-test" # name
header-group: "your_value"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_proxyaddress_headergroup_module.html
