Модуль community.general.utm_network_interface_address – Создание, обновление или удаление объекта network/interface_address

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.utm_network_interface_address.

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

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

Создание, обновление или удаление объекта network/interface_address в SOPHOS UTM.
Для работы этого модуля необходимо активировать REST-возможности UTM.

Параметры

Параметр	Комментарии
address string / required	IP4-адрес объекта network/interface_address.
address6 string	IP6-адрес объекта network/interface_address.
comment string	Необязательный комментарий для добавления к объекту Значение по умолчанию: `""`
headers dictionary	Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходимо для некоторых модулей. Значение по умолчанию: `{}`
name string / required	Имя объекта. Будет использоваться для идентификации записи
resolved boolean	Разрешен ли объект Варианты: `false` `true`
resolved6 boolean	Разрешен ли объект Варианты: `false` `true`
state string	Требуемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он присутствовал. Варианты: `"absent"` `"present"` ← (по умолчанию)
utm_host string / required	REST-точка доступа Sophos UTM.
utm_port integer	Порт REST-интерфейса. Значение по умолчанию: `4444`
utm_protocol string	Протокол REST-точки доступа. Варианты: `"http"` `"https"` ← (по умолчанию)
utm_token string / required	Токен, используемый для идентификации в 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	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, должно измениться в режиме `check_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 строка	IP4-адрес объекта network/interface_address Возвращено: успех
address6 строка	IP6-адрес объекта network/interface_address Возвращено: успех
comment строка	Строка комментария Возвращено: успех
name строка	Имя объекта Возвращено: успех
resolved логический	Решен ли объект Возвращено: успех
resolved6 логический	Решен ли объект Возвращено: успех

Авторы

Juergen Wiebe (@steamx)

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

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