Модуль fortinet.fortios.fortios_system_replacemsg_image – Настройка изображений сообщений замены в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: fortinet.fortios.fortios_system_replacemsg_image.
Новое в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию replacemsg_image. Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием. Тестировалось с FOS v6.0.0.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Выбором:
|
member_path строка | Путь к атрибуту члена для работы. Разделяется слешем, если атрибутов более одного. Параметр, помеченный member_path, подходит для работы с членами. |
member_state строка | Добавление или удаление члена по указанному пути атрибута. При указании member_state параметр state игнорируется. Выбором:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Выбором:
|
system_replacemsg_image словарь | Настройка изображений сообщений замены. |
|
image_base64 строка |
Данные изображения. |
|
image_type строка |
Тип изображения. Выбором:
|
|
name строка / обязательно |
Имя изображения. |
vdom строка | Виртуальная домен, среди тех, которые были определены ранее. VDOM — это виртуальная копия FortiGate, которая может настраиваться и использоваться как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска книг задач
- Модуль поддерживает режим check_mode.
Примеры
- name: Configure replacement message images.
fortinet.fortios.fortios_system_replacemsg_image:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_image:
image_base64: "<your_own_value>"
image_type: "gif"
name: "default_name_5"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для внедрения контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_replacemsg_image_module.html