Модуль fortinet.fortimanager.fmgr_switchcontroller_managedswitch_remotelog — настройка ведения журналов устройством FortiSwitch на удалённом сервере syslog.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_managedswitch_remotelog.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
managed-switch string | Устаревший параметр, используйте «managed_switch» |
managed_switch string | Параметр (managed-switch) в запрашиваемом URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
switchcontroller_managedswitch_remotelog dictionary | Набор параметров верхнего уровня. |
|
csv string |
Включить или отключить формат значений, разделённых запятыми Варианты:
|
|
facility string |
Категория для записи на удалённый сервер syslog. Варианты:
|
|
name string / обязательный |
Имя удалённого журнала. |
|
port integer |
Порт удалённого сервера syslog, на котором он ожидает подключения. |
|
server string |
IPv4-адрес удалённого сервера syslog. |
|
severity string |
Важность журналов, передаваемых на удалённый сервер журналов. Варианты:
|
|
status string |
Включить или отключить ведение журналов устройством FortiSwitch на удалённом сервере syslog. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы именуются с использованием соглашения об именовании с подчёркиванием (snake_case). Замените такие аргументы, как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout позволяют управлять этой функцией.
- Обычно выполнение модуля завершается ошибкой, если возвращён ненулевой код rc. Условия, при которых выполнение считается неудачным или успешным, можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Для создания или обновления объекта используйте указание state present.
- Для удаления объекта используйте указание state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure logging by FortiSwitch device to a remote syslog server.
fortinet.fortimanager.fmgr_switchcontroller_managedswitch_remotelog:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
managed_switch: <your own value>
state: present # <value in [present, absent]>
switchcontroller_managedswitch_remotelog:
name: "your value" # Required variable, string
# csv: <value in [disable, enable]>
# facility: <value in [kernel, user, mail, ...]>
# port: <integer>
# server: <string>
# severity: <value in [emergency, alert, critical, ...]>
# status: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_managedswitch_remotelog_module.html
