Модуль cisco.dnac.file_info – Модуль информации о файле

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.file_info.

Новинка в cisco.dnac 3.1.0

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

Обзор

Получение файла по идентификатору.
Загрузка файла, указанного по fileId.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dirPath строка	Абсолютный путь к каталогу. По умолчанию — текущий рабочий каталог.
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"`
fileId строка	Параметр пути fileId. Номер идентификации файла.
filename строка	Имя файла, используемое для сохранения загруженного файла.
headers словарь	Дополнительные заголовки.
saveFile логический тип	Включить или отключить автоматическое создание файла из необработанного ответа. Варианты: `false` `true`
validate_response_schema логический тип	Флаг для Cisco DNA Center SDK, для включения проверки запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK — file.File.download_a_file_by_fileid,
Используемые пути — get /dna/intent/api/v1/file/{fileId},
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины соединения ansible, а вместо этого встроенный менеджер соединений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Get File by id
  cisco.dnac.file_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}}"
    fileId: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список со значением, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"data": "filecontent", "dirpath": "download/directory", "filename": "filename", "path": "download/directory/filename"}`

Авторы

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/file_info_module.html