Модуль fortinet.fortimanager.fmgr_application_internetservicecustom_disableentry — Отключение записей в базе данных Интернет-служб.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook укажите: fortinet.fortimanager.fmgr_application_internetservicecustom_disableentry.
Новый в fortinet.fortimanager 2.2.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
application_internetservicecustom_disableentry словарь | Настройка параметров верхнего уровня. |
|
id целое число / обязательно |
ID для отключения записи. |
|
ip-range список / элементы=словарь |
Устаревшее, пожалуйста, переименуйте в ip_range. Диапазон IP-адресов. |
|
end-ip строка |
Устаревшее, пожалуйста, переименуйте в end_ip. Конечный IP-адрес. |
|
id целое число |
ID диапазона для отключения записи. |
|
start-ip строка |
Устаревшее, пожалуйста, переименуйте в start_ip. Начальный IP-адрес. |
|
port любой |
(список) Порт. |
|
protocol целое число |
Номер протокола. |
bypass_validation логический | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log логический | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
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. Также можно переопределить условия для завершения с ошибкой или успехом с помощью параметров 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: Disable entries in the Internet service database.
fortinet.fortimanager.fmgr_application_internetservicecustom_disableentry:
# 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>
internet_service_custom: <your own value>
state: present # <value in [present, absent]>
application_internetservicecustom_disableentry:
id: <integer>
ip_range:
-
end_ip: <string>
id: <integer>
start_ip: <string>
port: <list or integer>
protocol: <integer>
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
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_application_internetservicecustom_disableentry_module.html
