fortinet.fortimanager.fmgr_firewall_service_group модуль — Настройка групп служб.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_service_group.
Новое в fortinet.fortimanager 1.0.0
Описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить согласно данным источникам перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_service_group словарь | Настройка параметров верхнего уровня. |
|
color целое число |
Цвет значка на графическом интерфейсе. |
|
comment любой |
(словарь или строка) Комментарий. |
|
explicit_proxy строка |
Устарело, пожалуйста, переименуйте на explicit_proxy. Включить/выключить явную веб-прокси-группу служб. Варианты:
|
|
fabric_object строка |
Устарело, пожалуйста, переименуйте на fabric_object. Настройка глобального объекта Security Fabric. Варианты:
|
|
global_object целое число |
Устарело, пожалуйста, переименуйте на global_object. Глобальный объект. |
|
member любой |
(список или строка) Объекты служб, содержащиеся в группе. |
|
name строка / обязательно |
Имя группы адресов. |
|
proxy строка |
Включить/выключить веб-прокси-группу служб. Варианты:
|
|
uuid строка |
Универсальный уникальный идентификатор |
forticloud_access_token строка | Авторизация клиента Ansible с помощью маркера доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия отказа. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure service groups.
fortinet.fortimanager.fmgr_firewall_service_group:
bypass_validation: false
adom: ansible
state: present
firewall_service_group:
color: 1
comment: "ansible-comment"
name: "ansible-test-group"
proxy: disable
- 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 service groups
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_service_group"
params:
adom: "ansible"
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_service_group_module.html
