Модуль fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries – Список разрешённых/запрещённых точек доступа.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries.
Добавлен в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager. Модуль продолжает выполняться без проверки параметров. Варианты:
|
carrier-endpoint-bwl строка | Устаревшее, используйте «carrier_endpoint_bwl» |
carrier_endpoint_bwl строка | Параметр (carrier-endpoint-bwl) в запрошенном URL. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_carrierendpointbwl_entries словарь | Настройка параметров верхнего уровня. |
|
action список / элементы=строка |
Действие, которое необходимо выполнить для этого конечной точки. Варианты:
|
|
carrier_endpoint строка / обязательно |
Устаревшее, переименуйте на carrier_endpoint. Конечная точка для действия. |
|
log_action список / элементы=строка |
Устаревшее, переименуйте на log_action. Действие, которое необходимо выполнить для этой конечной точки. Варианты:
|
|
pattern_type строка |
Устаревшее, переименуйте на pattern_type. Маска подстановки или регулярное выражение. Варианты:
|
|
status строка |
Включить/выключить указанное действие. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
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. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров 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: Carrier end point black/white list.
fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries:
bypass_validation: false
adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
carrier-endpoint-bwl: "1" # id
state: present
firewall_carrierendpointbwl_entries:
action:
- block
- exempt
- exempt-mass-mms
carrier-endpoint: "string"
log-action:
- archive
- intercept
pattern-type: wildcard # <value in [wildcard, regexp, simple]>
status: enable
- 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 carrier endpoint black/white list table
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_carrierendpointbwl_entries"
params:
adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
carrier-endpoint-bwl: "1" # id
entries: "your_value"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_carrierendpointbwl_entries_module.html
