Модуль fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries – черный/белый список конечных точек оператора связи.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
carrier-endpoint-bwl string	Устарело, используйте “carrier_endpoint_bwl”
carrier_endpoint_bwl string	Параметр (carrier-endpoint-bwl) в запрошенном URL.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_carrierendpointbwl_entries dictionary	Набор параметров верхнего уровня.
action list / elements=string	Действие для этой конечной точки Варианты: `"block"` `"exempt"` `"exempt-mass-mms"`
carrier_endpoint псевдонимы: carrier-endpoint string / обязательный	Конечная точка, к которой применяется действие.
log_action псевдонимы: log-action list / elements=string	Действие для этой конечной точки Варианты: `"archive"` `"intercept"`
pattern_type псевдонимы: pattern-type string	Шаблон с подстановочными знаками или регулярное выражение. Варианты: `"wildcard"` `"regexp"` `"simple"`
status string	Включить или отключить указанное действие Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Инструкция по созданию, обновлению или удалению объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства; значение может быть global или другим, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 все входные аргументы именуются с использованием соглашения об именовании через подчеркивание (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но при их использовании выводятся предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочего пространства; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout позволяют управлять этим режимом.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_carrierendpointbwl_entries_module.html