Модуль community.general.utm_network_interface_address_info — получение сведений об объекте network/interface_address

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

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

Чтобы использовать её в плейбуке, укажите: community.general.utm_network_interface_address_info.

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

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

Получение сведений об объекте network/interface_address в SOPHOS UTM.

Параметры

Параметр	Комментарии
headers dictionary	Словарь дополнительных заголовков, отправляемых в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
name string / обязательный	Имя объекта, идентифицирующее запись.
state string	Требуемое состояние объекта. `present` создаёт объект или обновляет его. `absent` удаляет объект, если он существует. Варианты: `"absent"` `"present"` ← (по умолчанию)
utm_host string / обязательный	Конечная точка REST-интерфейса Sophos UTM.
utm_port integer	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol string	Протокол конечной точки REST. Варианты: `"http"` `"https"` ← (по умолчанию)
utm_token string / обязательный	Токен для идентификации в REST API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, глава 2.4.2.
validate_certs boolean	Следует ли проверять SSL-сертификат REST-интерфейса. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная добавлено в community.general 3.3.0 Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, требуется изменить в `check_mode`).

Примеры

- name: Get network interface address info
  utm_proxy_interface_address_info:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestNetworkInterfaceAddress

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

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

Ключ	Описание
result complex	Объект UTM, созданный модулем. Возвращается: при успешном выполнении
_locked boolean	Заблокирован ли объект в данный момент. Возвращается: при успешном выполнении
_ref string	Ссылочное имя объекта. Возвращается: при успешном выполнении
_type string	Тип объекта. Возвращается: при успешном выполнении
address string	Адрес IPv4 объекта network/interface_address. Возвращается: при успешном выполнении
address6 string	Адрес IPv6 объекта network/interface_address. Возвращается: при успешном выполнении
comment string	Текст комментария. Возвращается: при успешном выполнении
name string	Имя объекта. Возвращается: при успешном выполнении
resolved boolean	Разрешён ли объект. Возвращается: при успешном выполнении
resolved6 boolean	Разрешён ли объект. Возвращается: при успешном выполнении

Авторы

Juergen Wiebe (@steamx)

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

© 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/community/general/utm_network_interface_address_info_module.html