fortinet.fortimanager.fmgr_firewall_internetserviceaddition модуль — Настройка добавления интернет-служб.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_internetserviceaddition.
Новое в fortinet.fortimanager 2.1.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать под источники данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_internetserviceaddition словарь | Установленные параметры верхнего уровня. |
|
comment строка |
Комментарий. |
|
entry список / элементы=словарь |
Элемент. |
|
addr-mode строка |
Устаревшее, пожалуйста, переименуйте на addr_mode. Режим адреса Варианты:
|
|
id целое число |
Идентификатор элемента |
|
port-range список / элементы=словарь |
Устаревшее, пожалуйста, переименуйте на port_range. Диапазон портов. |
|
end-port целое число |
Устаревшее, пожалуйста, переименуйте на end_port. Целочисленное значение конечного TCP/UDP/SCTP порта в диапазоне |
|
id целое число |
Пользовательский идентификатор диапазона портов. |
|
start-port целое число |
Устаревшее, пожалуйста, переименуйте на start_port. Целочисленное значение начального TCP/UDP/SCTP порта в диапазоне |
|
protocol целое число |
Целочисленное значение типа протокола, определенного IANA |
|
id строка / обязательно |
Идентификатор интернет-службы в базе данных интернет-служб. |
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_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 Internet Services Addition.
fortinet.fortimanager.fmgr_firewall_internetserviceaddition:
# 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]>
firewall_internetserviceaddition:
comment: <string>
entry:
-
id: <integer>
port_range:
-
end_port: <integer>
id: <integer>
start_port: <integer>
protocol: <integer>
addr_mode: <value in [ipv4, ipv6]>
id: <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_internetserviceaddition_module.html
