fortinet.fortimanager.fmgr_firewall_internetservicecustom_disableentry модуль — Отключение записей в базе данных интернет-служб.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_firewall_internetservicecustom_disableentry.
Новая функция в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_internetservicecustom_disableentry словарь | Настройка параметров верхнего уровня. |
|
id целое число / обязательно |
ID записи для отключения. |
|
ip_range список / элементы=словарь |
Устарело, пожалуйста, переименуйте на ip_range. Диапазон IP-адресов. |
|
end_ip строка |
Устарело, пожалуйста, переименуйте на end_ip. Конечный IP-адрес. |
|
id целое число |
ID диапазона записей для отключения. |
|
start_ip строка |
Устарело, пожалуйста, переименуйте на start_ip. Начальный IP-адрес. |
|
port любой |
(список) Целочисленное значение для TCP/IP порта |
|
protocol целое число |
Целочисленное значение для типа протокола, определенного IANA |
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к forticloud API. |
internet_service_custom строка | Устарело, пожалуйста, используйте “internet_service_custom” |
internet_service_custom строка | Параметр (internet-service-custom) в запрошенном 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_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: Disable entries in the Internet Service database.
fortinet.fortimanager.fmgr_firewall_internetservicecustom_disableentry:
bypass_validation: false
adom: ansible
internet-service-custom: "ansible-test" # name
state: present
firewall_internetservicecustom_disableentry:
id: 1
port: 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 disable entries in the custom internet service
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_internetservicecustom_disableentry"
params:
adom: "ansible"
internet-service-custom: "ansible-test" # name
disable-entry: "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_internetservicecustom_disableentry_module.html
