Модуль cisco.dnac.network_device_user_defined_field_delete — Модуль ресурсов для удаления пользовательских полей сетевого устройства

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

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

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: cisco.dnac.network_device_user_defined_field_delete.

Новая функция в cisco.dnac 6.14.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Описание

Управление операцией удаления ресурса «Удаление пользовательских полей сетевого устройства».
Удаление пользовательского поля с устройства. Имя пользовательского поля должно быть передано в качестве параметра запроса. Обратите внимание, что глобальные пользовательские поля не будут удалены с помощью этой операции.

Примечание

Для этого модуля есть соответствующий плагин действий.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
deviceId строка	Параметр пути deviceId. UUID устройства, из которого нужно удалить пользовательское поле.
dnac_debug логическое значение	Флаг для Cisco DNA Center SDK, который включает отладку. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логическое значение	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
name строка	Параметр запроса name. Имя пользовательского поля для удаления.
validate_response_schema логическое значение	Флаг для Cisco DNA Center SDK, который включает проверку соответствия тел запросов JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: devices.Devices.remove_user_defined_field_from_device,
Используемые пути: delete /dna/intent/api/v1/network-device/{deviceId}/user-defined-field,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по устройствам RemoveUserDefinedFieldFromDevice: Полное описание API RemoveUserDefinedFieldFromDevice.

Примеры

- name: Delete all
  cisco.dnac.network_device_user_defined_field_delete:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    deviceId: string
    name: string

Значения возврата

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращаемое значение: всегда Пример: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/dnac/network_device_user_defined_field_delete_module.html