fortinet.fortimanager.fmgr_wireless_syslogprofile модуль — Настройка беспроводных точек завершения
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия завершения с ошибкой. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия успешного завершения. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
wireless_syslogprofile словарь | Настроеные параметры верхнего уровня. |
|
comment строка |
Комментарий. |
|
log_level строка |
Устарело, используйте log_level. Минимальный уровень сообщений журнала, которые устройства FortiAP отправляют на этот сервер Варианты:
|
|
name строка / обязательно |
Имя профиля сервера WTP системного журнала. |
|
server_addr_type строка |
Устарело, используйте server_addr_type. Тип адреса сервера syslog Варианты:
|
|
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 Варианты:
|
workspace_locking_adom строка | Область, которую следует заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют именование по соглашению snake_case. Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения о устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в файле ansible.cfg.
- В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей, если возвращён ненулевой код rc. Вы также можете переопределить условия неудачи или успеха с параметрами rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure Wireless Termination Points
fortinet.fortimanager.fmgr_wireless_syslogprofile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
wireless_syslogprofile:
comment: <string>
log_level: <value in [emergency, alert, critical, ...]>
name: <string>
server_addr_type: <value in [fqdn, ip]>
server_fqdn: <string>
server_ip: <string>
server_port: <integer>
server_status: <value in [disable, enable]>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращаемое значение: всегда |
|
request_url строка |
Полный URL запроса. Возвращаемое значение: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращаемое значение: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращаемое значение: всегда |
|
response_message строка |
Описание ответа API. Возвращаемое значение: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращаемое значение: всегда |
rc целое число | Статус запроса. Возвращаемое значение: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращаемое значение: комплексное |
Ссылки на коллекцию
© 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/fortimanager/fmgr_wireless_syslogprofile_module.html
