Модуль fortinet.fortios.fortios_system_replacemsg_admin – Сообщения замещения в 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_admin.
Впервые появился в fortinet.fortios 2.0.0
Описание
- Этот модуль может настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_replacemsg и категорию администрирования. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется слешем, если атрибутов несколько. Параметр, помеченный member_path, является допустимым для выполнения операций с членом. |
member_state строка | Добавление или удаление члена по указанному пути атрибута. Когда задан member_state, параметр state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создавать или удалять объект. Варианты:
|
system_replacemsg_admin словарь | Сообщения замещения. |
|
buffer строка |
Строка сообщения. |
|
format строка |
Флаг формата. Варианты:
|
|
header строка |
Флаг заголовка. Варианты:
|
|
msg_type строка / обязательно |
Тип сообщения. |
vdom строка | Виртуальная домен, среди тех, что определены ранее. ВДМ представляет собой виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi является предпочтительным способом запуска книг задач
- Модуль поддерживает режим проверки.
Примеры
- name: Replacement messages.
fortinet.fortios.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 Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (идентификатор), использованный в последнем вызове FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер версии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Использованная виртуальная область Возвращается: всегда Пример: |
version строка | Версия 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_admin_module.html
