fortinet.fortios.fortios_system_replacemsg_admin – Сообщения замены в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в состав коллекции fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в книге задач укажите: fortinet.fortios.fortios_system_replacemsg_admin.
В версии 2.9: коллекции fortinet.fortios
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_replacemsg и категорию admin. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_token
строка
|
Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate.
|
||
| state
строка / обязательно
|
|
Указывает, нужно ли создавать или удалять объект. |
|
| system_replacemsg_admin
словарь
|
Сообщения замены. |
||
| buffer
строка
|
Строка сообщения. |
||
| format
строка
|
|
Флаг формата. |
|
| header
строка
|
|
Флаг заголовка. |
|
| msg_type
строка
|
Тип сообщения. |
||
| vdom
строка
|
По умолчанию: "root" |
Виртуальная область, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. |
|
Примечания
Примечание
- Устаревший fortiosapi устарел, httpapi является предпочтительным способом выполнения книг задач.
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Replacement messages.
fortios_system_replacemsg_admin:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_admin:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build
строка
|
всегда | Номер сборки образа fortigate
Пример:
1547
|
| http_method
строка
|
всегда | Последний используемый метод для предоставления контента в FortiGate
Пример:
PUT
|
| http_status
строка
|
всегда | Последний результат, полученный от FortiGate при последнем примененном действии
Пример:
200
|
| mkey
строка
|
успех | Главный ключ (id), используемый в последнем вызове FortiGate
Пример:
id
|
| name
строка
|
всегда | Имя таблицы, используемой для выполнения запроса
Пример:
urlfilter
|
| path
строка
|
всегда | Путь таблицы, используемой для выполнения запроса
Пример:
webfilter
|
| revision
строка
|
всегда | Внутренний номер пересмотра
Пример:
17.0.2.10658
|
| serial
строка
|
всегда | Серийный номер устройства
Пример:
FGVMEVYYQT3AB5352
|
| status
строка
|
всегда | Указание результата операции
Пример:
успех
|
| vdom
строка
|
всегда | Используемая виртуальная область
Пример:
root
|
| version
строка
|
всегда | Версия FortiGate
Пример:
v5.6.3
|
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_system_replacemsg_admin_module.html