fortinet.fortimanager.fmgr_firewall_mmsprofile_notification модуль – Настройка уведомлений.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

У вас возможно уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_mmsprofile_notification.

Добавлена в fortinet.fortimanager 2.0.0

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных, перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без валидации параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_mmsprofile_notification словарь	Установленные параметры верхнего уровня.
alert-int целое число	Устаревшее, пожалуйста, переименуйте на alert_int. Интервал отправки уведомлений об оповещениях.
alert-int-mode строка	Устаревшее, пожалуйста, переименуйте на alert_int_mode. Режим интервала уведомлений об оповещениях. Варианты: `"hours"` `"minutes"`
alert-src-msisdn строка	Устаревшее, пожалуйста, переименуйте на alert_src_msisdn. Укажите адрес источника для сообщений об оповещениях.
alert-status строка	Устаревшее, пожалуйста, переименуйте на alert_status. Статус уведомлений об оповещениях. Варианты: `"disable"` `"enable"`
bword-int целое число	Устаревшее, пожалуйста, переименуйте на bword_int. Интервал отправки уведомлений о запрещенных словах.
bword-int-mode строка	Устаревшее, пожалуйста, переименуйте на bword_int_mode. Режим интервала уведомлений о запрещенных словах. Варианты: `"hours"` `"minutes"`
bword-status строка	Устаревшее, пожалуйста, переименуйте на bword_status. Статус уведомлений о запрещенных словах. Варианты: `"disable"` `"enable"`
carrier-endpoint-bwl-int целое число	Устаревшее, пожалуйста, переименуйте на carrier_endpoint_bwl_int. Интервал отправки уведомлений о списке черного/белого списка конечных точек оператора.
carrier-endpoint-bwl-int-mode строка	Устаревшее, пожалуйста, переименуйте на carrier_endpoint_bwl_int_mode. Режим интервала уведомлений о списке черного/белого списка конечных точек оператора. Варианты: `"hours"` `"minutes"`
carrier-endpoint-bwl-status строка	Устаревшее, пожалуйста, переименуйте на carrier_endpoint_bwl_status. Статус уведомлений о списке черного/белого списка конечных точек оператора. Варианты: `"disable"` `"enable"`
days-allowed список / элементы=строка	Устаревшее, пожалуйста, переименуйте на days_allowed. Дни недели, в которые могут быть отправлены сообщения уведомлений. Варианты: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
detect-server строка	Устаревшее, пожалуйста, переименуйте на detect_server. Включить/выключить автоматическое определение адреса сервера. Варианты: `"disable"` `"enable"`
dupe-int целое число	Устаревшее, пожалуйста, переименуйте на dupe_int. Интервал отправки уведомлений о дубликатах.

dupe-int-mode string	Устарело, переименуйте в dupe_int_mode. Режим интервала дублирующего уведомления. Choices: `"hours"` `"minutes"`
dupe-status string	Устарело, переименуйте в dupe_status. Статус дублирующего уведомления. Choices: `"disable"` `"enable"`
file-block-int integer	Устарело, переименуйте в file_block_int. Интервал отправки уведомлений о блокировке файла.
file-block-int-mode string	Устарело, переименуйте в file_block_int_mode. Режим интервала уведомлений о блокировке файла. Choices: `"hours"` `"minutes"`
file-block-status string	Устарело, переименуйте в file_block_status. Статус уведомлений о блокировке файла. Choices: `"disable"` `"enable"`
flood-int integer	Устарело, переименуйте в flood_int. Интервал отправки уведомлений о потоке.
flood-int-mode string	Устарело, переименуйте в flood_int_mode. Режим интервала уведомлений о потоке. Choices: `"hours"` `"minutes"`
flood-status string	Устарело, переименуйте в flood_status. Статус уведомлений о потоке. Choices: `"disable"` `"enable"`
from-in-header string	Устарело, переименуйте в from_in_header. Включить/отключить вставку адреса отправителя в HTTP-заголовок. Choices: `"disable"` `"enable"`
mms-checksum-int integer	Устарело, переименуйте в mms_checksum_int. Интервал отправки уведомлений о контрольной сумме MMS.
mms-checksum-int-mode string	Устарело, переименуйте в mms_checksum_int_mode. Режим интервала уведомлений о контрольной сумме MMS. Choices: `"hours"` `"minutes"`
mms-checksum-status string	Устарело, переименуйте в mms_checksum_status. Статус уведомлений о контрольной сумме MMS. Choices: `"disable"` `"enable"`
mmsc-hostname string	Устарело, переименуйте в mmsc_hostname. Имя хоста или IP-адрес MMSC.
mmsc-password any	(list) Устарело, переименуйте в mmsc_password. Пароль, необходимый для аутентификации с MMSC.
mmsc-port integer	Устарело, переименуйте в mmsc_port. Порт, используемый на MMSC для отправки сообщений MMS.
mmsc-url string	Устарело, переименуйте в mmsc_url. URL-адрес, используемый на MMSC для отправки сообщений MMS.
mmsc-username string	Устарело, переименуйте в mmsc_username. Имя пользователя, необходимое для аутентификации с MMSC.
msg-protocol string	Устарело, переименуйте в msg_protocol. Протокол, используемый для отправки уведомлений. Choices: `"mm1"` `"mm3"` `"mm4"` `"mm7"`

msg-type string	Устаревшее, пожалуйста, переименуйте на msg_type. Тип сообщения MM7. Варианты: `"submit-req"` `"deliver-req"`
protocol string	Протокол.
rate-limit integer	Устаревшее, пожалуйста, переименуйте на rate_limit. Предел скорости отправки сообщений уведомлений
tod-window-duration string	Устаревшее, пожалуйста, переименуйте на tod_window_duration. Длительность временного интервала.
tod-window-end string	Устаревшее, пожалуйста, переименуйте на tod_window_end. Устарело.
tod-window-start string	Устаревшее, пожалуйста, переименуйте на tod_window_start. Начало временного интервала.
user-domain string	Устаревшее, пожалуйста, переименуйте на user_domain. Имя домена, к которому относятся пользователи.
vas-id string	Устаревшее, пожалуйста, переименуйте на vas_id. Идентификатор VAS.
vasp-id string	Устаревшее, пожалуйста, переименуйте на vasp_id. Идентификатор VASP.
virus-int integer	Устаревшее, пожалуйста, переименуйте на virus_int. Интервал отправки уведомлений о вирусах.
virus-int-mode string	Устаревшее, пожалуйста, переименуйте на virus_int_mode. Режим интервала уведомлений о вирусах. Варианты: `"hours"` `"minutes"`
virus-status string	Устаревшее, пожалуйста, переименуйте на virus_status. Статус уведомлений о вирусах. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Авторизовать клиент Ansible с помощью токена доступа к API forticloud.
mms-profile string	Устаревшее, пожалуйста, используйте “mms_profile”
mms_profile string	Параметр (mms-profile) в запрошенном URL.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия для отказа.
rc_succeeded list / elements=integer	Список кодов rc, с помощью которых будут переопределены условия для успеха.
workspace_locking_adom string	ADOM для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая 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

Примеры

- 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: Notification configuration.
      fortinet.fortimanager.fmgr_firewall_mmsprofile_notification:
        # 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>
        mms_profile: <your own value>
        firewall_mmsprofile_notification:
          alert_int: <integer>
          alert_int_mode: <value in [hours, minutes]>
          alert_src_msisdn: <string>
          alert_status: <value in [disable, enable]>
          bword_int: <integer>
          bword_int_mode: <value in [hours, minutes]>
          bword_status: <value in [disable, enable]>
          carrier_endpoint_bwl_int: <integer>
          carrier_endpoint_bwl_int_mode: <value in [hours, minutes]>
          carrier_endpoint_bwl_status: <value in [disable, enable]>
          days_allowed:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
          detect_server: <value in [disable, enable]>
          dupe_int: <integer>
          dupe_int_mode: <value in [hours, minutes]>
          dupe_status: <value in [disable, enable]>
          file_block_int: <integer>
          file_block_int_mode: <value in [hours, minutes]>
          file_block_status: <value in [disable, enable]>
          flood_int: <integer>
          flood_int_mode: <value in [hours, minutes]>
          flood_status: <value in [disable, enable]>
          from_in_header: <value in [disable, enable]>
          mms_checksum_int: <integer>
          mms_checksum_int_mode: <value in [hours, minutes]>
          mms_checksum_status: <value in [disable, enable]>
          mmsc_hostname: <string>
          mmsc_password: <list or string>
          mmsc_port: <integer>
          mmsc_url: <string>
          mmsc_username: <string>
          msg_protocol: <value in [mm1, mm3, mm4, ...]>
          msg_type: <value in [submit-req, deliver-req]>
          protocol: <string>
          rate_limit: <integer>
          tod_window_duration: <string>
          tod_window_end: <string>
          tod_window_start: <string>
          user_domain: <string>
          vas_id: <string>
          vasp_id: <string>
          virus_int: <integer>
          virus_int_mode: <value in [hours, minutes]>
          virus_status: <value in [disable, enable]>

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_mmsprofile_notification_module.html