Модуль fortinet.fortimanager.fmgr_firewall_mmsprofile_notifmsisdn — Уведомления для MSISDN.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_mmsprofile_notifmsisdn.
Новая функция в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для данных источников перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_mmsprofile_notifmsisdn словарь | Настройка верхнего уровня. |
|
msisdn строка / обязательно |
MSISDN получателя. |
|
threshold список / элементы=строка |
Пороговые значения, при которых этот MSISDN получит оповещение. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
mms-profile строка | Устарело, пожалуйста, используйте «mms_profile» |
mms_profile строка | Параметр (mms-profile) в запрошенном URL. |
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: Notification for MSISDNs.
fortinet.fortimanager.fmgr_firewall_mmsprofile_notifmsisdn:
bypass_validation: false
adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
mms-profile: "ansible-test" # name
state: present
firewall_mmsprofile_notifmsisdn:
msisdn: "ansible"
threshold:
- flood-thresh-1
- flood-thresh-2
- flood-thresh-3
- dupe-thresh-1
- dupe-thresh-2
- dupe-thresh-3
- 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 Notification for MSISDNs
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_mmsprofile_notifmsisdn"
params:
adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
mms-profile: "ansible-test" # name
notif-msisdn: "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_mmsprofile_notifmsisdn_module.html
