Модуль cisco.dnac.network_device_user_defined_field_update – Модуль ресурса для обновления пользовательского поля устройства сети

Примечание

Этот модуль является частью коллекции 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_update.

Новое в cisco.dnac 6.14.0

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

Обзор

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
deviceId строка	Параметр пути deviceId. UUID устройства, которому нужно добавить UDF.
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"`
payload список / элементы=словарь	Полезная нагрузка для обновления пользовательского поля устройства сети.
name строка	Имя пользовательского поля.
value строка	Значение пользовательского поля, которое будет назначено устройству.
validate_response_schema булево	Флаг для Cisco DNA Center SDK для включения валидации запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.dnac.network_device_user_defined_field_update:
    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
    payload:
    - name: string
      value: 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_update_module.html