Модуль community.general.utm_network_interface_address — создание, обновление или удаление объекта 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.
Краткое описание
- Создаёт, обновляет или удаляет объект network/interface_address в SOPHOS UTM.
- Для работы этого модуля необходимо активировать REST-возможности UTM.
Параметры
Параметр | Комментарии |
|---|---|
address строка / обязательный | IPv4-адрес объекта network/interface_address. |
address6 строка | IPv6-адрес объекта network/interface_address. |
comment строка | Необязательный комментарий для объекта. По умолчанию: |
headers словарь | Словарь дополнительных заголовков, передаваемых в запросах POST и PUT. Требуется для некоторых модулей. По умолчанию: |
name строка / обязательный | Имя объекта, идентифицирующее запись. |
resolved логический | Указывает, разрешён ли объект. Варианты:
|
resolved6 логический | Указывает, разрешён ли объект. Варианты:
|
state строка | Требуемое состояние объекта.
Варианты:
|
utm_host строка / обязательный | Конечная точка REST Sophos UTM. |
utm_port целое число | Порт интерфейса REST. По умолчанию: |
utm_protocol строка | Протокол конечной точки REST. Варианты:
|
utm_token строка / обязательный | Токен для аутентификации в REST API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, раздел 2.4.2. |
validate_certs логический | Проверять ли SSL-сертификат интерфейса REST. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: нет | Может работать в режиме |
diff_mode | Поддержка: нет | В режиме diff возвращает сведения о том, что изменилось (или, возможно, требует изменения в |
Примеры
- name: Create a network interface address
utm_proxy_backend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestNetworkInterfaceAddress
address: 0.0.0.0
state: present
- name: Remove a network interface address
network_interface_address:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestNetworkInterfaceAddress
address: 0.0.0.0
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
result сложный тип | Созданный объект UTM. Возвращается: при успешном выполнении |
|
_locked логический |
Указывает, заблокирован ли объект в данный момент. Возвращается: при успешном выполнении |
|
_ref строка |
Имя ссылки на объект. Возвращается: при успешном выполнении |
|
_type строка |
Тип объекта. Возвращается: при успешном выполнении |
|
address строка |
IPv4-адрес объекта network/interface_address. Возвращается: при успешном выполнении |
|
address6 строка |
IPv6-адрес объекта network/interface_address. Возвращается: при успешном выполнении |
|
comment строка |
Строка комментария. Возвращается: при успешном выполнении |
|
name строка |
Имя объекта. Возвращается: при успешном выполнении |
|
resolved логический |
Указывает, разрешён ли объект. Возвращается: при успешном выполнении |
|
resolved6 логический |
Указывает, разрешён ли объект. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_module.html