fortinet.fortimanager.fmgr_log_npuserver_serverinfo модуль — настройка информации о сервере.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас может быть установлена эта коллекция, если используется пакет ansible. Она не включена в ansible-core. Для проверки установки выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_log_npuserver_serverinfo.
Добавлен в 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. |
log_npuserver_serverinfo словарь | Настройка параметров верхнего уровня. |
|
dest_port целое число |
Устарело, пожалуйста, переименуйте в dest_port. Установите порт назначения для пакета логов |
|
id целое число / обязательно |
Идентификатор сервера. |
|
ip_family строка |
Устарело, пожалуйста, переименуйте в ip_family. Установите версию IP-адреса Варианты:
|
|
ipv4_server строка |
Устарело, пожалуйста, переименуйте в ipv4_server. Установите IPv4-адрес сервера логов |
|
ipv6_server строка |
Устарело, пожалуйста, переименуйте в ipv6_server. Установите IPv6-адрес сервера логов |
|
log_transport строка |
Устарело, пожалуйста, переименуйте в log_transport. Установите протокол транспорта Варианты:
|
|
source_port целое число |
Устарело, пожалуйста, переименуйте в source_port. Установите порт источника для пакета логов |
|
template_tx_timeout целое число |
Устарело, пожалуйста, переименуйте в template_tx_timeout. Установите таймаут передачи шаблона |
|
vdom строка |
Интерфейс, подключенный к серверу логов, находится в этой виртуальной области |
proposed_method строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми условия отказа будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми условия успеха будут переопределены. |
state строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Adom для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневой. |
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 server info.
fortinet.fortimanager.fmgr_log_npuserver_serverinfo:
# 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]>
log_npuserver_serverinfo:
dest_port: <integer>
id: <integer>
ip_family: <value in [v4, v6]>
ipv4_server: <string>
ipv6_server: <string>
source_port: <integer>
template_tx_timeout: <integer>
vdom: <string>
log_transport: <value in [udp, tcp]>
Значения возврата
Общие значения возврата описаны здесь, а ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_log_npuserver_serverinfo_module.html
