Модуль fortinet.fortimanager.fmgr_wireless_syslogprofile — настройка точек беспроводного доступа

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_wireless_syslogprofile.

Добавлено в fortinet.fortimanager 2.2.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation логический	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Возможные значения: `false` ← (по умолчанию) `true`
enable_log логический	Включить или отключить ведение журнала для задачи. Возможные значения: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Возможные значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note строка	Примечание об изменениях, которое можно указать при создании или обновлении объекта.
state строка / обязательный	Директива для создания, обновления или удаления объекта. Возможные значения: `"present"` `"absent"`
wireless_syslogprofile словарь	Набор параметров верхнего уровня.
comment строка	Комментарий.
log_level псевдонимы: log-level строка	Минимальный уровень сообщений журнала, которые устройства FortiAP отправляют на этот сервер Возможные значения: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debugging"`
name строка / обязательный	Имя профиля системного журнала WTP.
server строка	Доменное имя CN или IP-адрес сервера Syslog.
server_addr_type псевдонимы: server-addr-type строка	Тип адреса сервера Syslog Возможные значения: `"fqdn"` `"ip"`
server_fqdn псевдонимы: server-fqdn строка	FQDN сервера Syslog, на который устройства FortiAP отправляют сообщения журнала.
server_ip псевдонимы: server-ip строка	IP-адрес сервера Syslog, на который устройства FortiAP отправляют сообщения журнала.
server_port псевдонимы: server-port целое число	Номер порта сервера Syslog, на который устройства FortiAP отправляют сообщения журнала
server_status псевдонимы: server-status строка	Включить или отключить отправку устройствами FortiAP сообщений журнала на сервер Syslog Возможные значения: `"disable"` `"enable"`
server_type псевдонимы: server-type строка	Настройка типа сервера Syslog Возможные значения: `"standard"` `"fortianalyzer"`
workspace_locking_adom строка	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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 Wireless Termination Points
      fortinet.fortimanager.fmgr_wireless_syslogprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        wireless_syslogprofile:
          name: "your value" # Required variable, string
          # comment: <string>
          # log_level: <value in [emergency, alert, critical, ...]>
          # server_addr_type: <value in [fqdn, ip]>
          # server_fqdn: <string>
          # server_ip: <string>
          # server_port: <integer>
          # server_status: <value in [disable, enable]>
          # server_type: <value in [standard, fortianalyzer]>
          # server: <string>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_wireless_syslogprofile_module.html