Модуль fortinet.fortimanager.fmgr_log_npuserver_serverinfo — настройка информации о сервере.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит работу без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
log_npuserver_serverinfo dictionary | Параметры верхнего уровня. |
|
dest_port псевдонимы: dest-port integer |
Задать порт назначения для пакета журнала |
|
id integer / обязательный |
Идентификатор сервера. |
|
ip_family псевдонимы: ip-family string |
Задать версию IP-адреса Варианты:
|
|
ipv4_server псевдонимы: ipv4-server string |
Задать IPv4-адрес сервера журналов |
|
ipv6_server псевдонимы: ipv6-server string |
Задать IPv6-адрес сервера журналов |
|
log_transport псевдонимы: log-transport string |
Задать транспортный протокол Варианты:
|
|
source_port псевдонимы: source-port integer |
Задать порт источника для пакета журнала |
|
template_tx_timeout псевдонимы: template-tx-timeout integer |
Задать тайм-аут передачи шаблона |
|
vdom string |
Интерфейс, подключенный к серверу журналов, находится в этом виртуальном домене |
|
vdom_ string |
Vdom. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, которыми переопределяются условия, при которых операция считается неудачной. |
rc_succeeded list / elements=integer | Список кодов rc, которыми переопределяются условия, при которых операция считается успешной. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
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 server info.
fortinet.fortimanager.fmgr_log_npuserver_serverinfo:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
log_npuserver_serverinfo:
id: 0 # Required variable, integer
# dest_port: <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]>
# vdom_: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=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_log_npuserver_serverinfo_module.html
