Модуль fortinet.fortios.fortios_system_replacemsg_traffic_quota – Сообщения о заменах в 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_traffic_quota.
Введено в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функции system_replacemsg и категорию traffic_quota. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерирована из GUI Fortigate. |
enable_log логический тип | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для выполнения операций. Разделяется символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, подходит для операций с членами. |
member_state строка | Добавление или удаление члена по указанному пути к атрибуту. Когда member_state указан, опция state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
system_replacemsg_traffic_quota словарь | Сообщения о заменах. |
|
buffer строка |
Текст сообщения. |
|
format строка |
Флаг формата. Варианты:
|
|
header строка |
Флаг заголовка. Варианты:
|
|
msg_type строка / обязательно |
Тип сообщения. |
vdom строка | Виртуальная область (vdom), среди ранее определённых. Vdom — виртуальная инстанция FortiGate, которая может настраиваться и использоваться как отдельная единица. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi является предпочтительным способом запуска книг задач
- Модуль поддерживает режим проверки.
Примеры
- name: Replacement messages.
fortinet.fortios.fortios_system_replacemsg_traffic_quota:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_replacemsg_traffic_quota:
buffer: "<your_own_value>"
format: "none"
header: "none"
msg_type: "<your_own_value>"
Значения возврата
Общие значения возврата задокументированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate по последней применённой операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове 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_traffic_quota_module.html
