cisco.dnac.network_device_lexicographically_sorted_info модуль – Модуль информации для сортировки устройств сети по алфавиту

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.dnac.network_device_lexicographically_sorted_info.

Добавлена в cisco.dnac 3.1.0

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

Описание

Получить все устройства сети, отсортированные по алфавиту.
Возвращает список значений первого заданного обязательного параметра.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
associatedWlcIp string	Параметр запроса AssociatedWlcIp.
collectionInterval string	Параметр запроса CollectionInterval.
collectionStatus string	Параметр запроса CollectionStatus.
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
errorCode string	Параметр запроса ErrorCode.
family string	Параметр запроса Family.
headers dictionary	Дополнительные заголовки.
hostname string	Параметр запроса Hostname.
limit integer	Параметр запроса Limit.
macAddress string	Параметр запроса MacAddress.
managementIpAddress string	Параметр запроса ManagementIpAddress.
offset integer	Параметр запроса Offset.
platformId string	Параметр запроса PlatformId.
reachabilityFailureReason string	Параметр запроса ReachabilityFailureReason.
reachabilityStatus string	Параметр запроса ReachabilityStatus.
role string	Параметр запроса Role.
roleSource string	Параметр запроса RoleSource.
serialNumber string	Параметр запроса SerialNumber.
series string	Параметр запроса Series.

softwareType string	Параметр запроса SoftwareType.
softwareVersion string	Параметр запроса SoftwareVersion.
type string	Параметр запроса Type.
upTime string	Параметр запроса UpTime.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, который включает проверку тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)
vrfName string	Параметр запроса VrfName.

Примечания

Примечание

Используемые методы SDK: devices.Devices.get_device_values_that_match_fully_or_partially_an_attribute,
Используемые пути: get /dna/intent/api/v1/network-device/autocomplete,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для Devices GetDeviceValuesThatMatchFullyOrPartiallyAnAttribute: Полное описание API GetDeviceValuesThatMatchFullyOrPartiallyAnAttribute.

Примеры

- name: Get all Network Device Lexicographically Sorted
  cisco.dnac.network_device_lexicographically_sorted_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    vrfName: string
    managementIpAddress: string
    hostname: string
    macAddress: string
    family: string
    collectionStatus: string
    collectionInterval: string
    softwareVersion: string
    softwareType: string
    reachabilityStatus: string
    reachabilityFailureReason: string
    errorCode: string
    platformId: string
    series: string
    type: string
    serialNumber: string
    upTime: string
    role: string
    roleSource: string
    associatedWlcIp: string
    offset: 0
    limit: 0
  register: result

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

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

Ключ	Описание
dnac_response string	Словарь или список со значением, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `"\"string\"\n"`

Авторы

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_lexicographically_sorted_info_module.html