win_stat – Получение информации о файлах Windows

Новое в версии 1.7.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Возвращает информацию о файле Windows.
Для платформ, не являющихся Windows, используйте модуль stat вместо этого.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
checksum_algorithm - добавлен в 2.3	Варианты: md5 sha1 ← sha256 sha384 sha512	Алгоритм для определения контрольной суммы файла. Вызовет ошибку, если хост не поддерживает указанный алгоритм.
get_checksum boolean добавлен в 2.1	Варианты: no yes ←	Возвращать контрольную сумму файла (по умолчанию sha1)
get_md5 boolean	Варианты: no ← yes	Возвращать контрольную сумму файла. В Ansible 1.9 - 2.2 это уже не MD5, а SHA1. С Ansible 2.3 это опять MD5. Возвратит None, если хост не поддерживает указанный алгоритм. По умолчанию этого параметра изменился с `yes` на `no` в Ansible 2.5 и будет удален в Ansible 2.9. Используйте `get_checksum=true` с `checksum_algorithm=md5` для возврата хэша md5 в поле `checksum` возвращаемых значений.
path path / обязательно		Полный путь к файлу/объекту, для которого необходимо получить информацию; поддерживаются как прямые, так и обратные слэши.

Примечания

Примечание

Для платформ, не являющихся Windows, используйте модуль stat вместо этого.

Примеры

- name: Obtain information about a file
  win_stat:
    path: C:\foo.ini
  register: file_info

- name: Obtain information about a folder
  win_stat:
    path: C:\bar
  register: folder_info

- name: Get MD5 checksum of a file
  win_stat:
    path: C:\foo.ini
    get_checksum: yes
    checksum_algorithm: md5
  register: md5_checksum

- debug:
    var: md5_checksum.stat.checksum

- name: Get SHA1 checksum of file
  win_stat:
    path: C:\foo.ini
    get_checksum: yes
  register: sha1_checksum

- debug:
    var: sha1_checksum.stat.checksum

- name: Get SHA256 checksum of file
  win_stat:
    path: C:\foo.ini
    get_checksum: yes
    checksum_algorithm: sha256
  register: sha256_checksum

- debug:
    var: sha256_checksum.stat.checksum

Возвращаемые значения

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

Ключ		Возвращаемое значение	Описание
changed boolean		всегда	Указание, были ли внесены какие-либо изменения Пример: True
stat complex		успех	Словарь, содержащий все данные stat
	attributes строка	успех, путь существует	Атрибуты файла по указанному пути в сыром виде Пример: Архив, Скрытый
	checksum строка	успех, путь существует, путь — файл, get_checksum == True, заданный алгоритм checksum поддерживается	Хеш-сумма файла, основанная на заданном алгоритме checksum_algorithm Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98
	creationtime число с плавающей точкой	успех, путь существует	Время создания файла, представленное в секундах с момента эпохи Пример: 1477984205.15
	exists boolean	успех	Существует ли путь или нет Пример: True
	extension строка	успех, путь существует, путь — файл	Расширение файла по указанному пути Пример: .ps1
	filename строка	успех, путь существует, путь — файл	Имя файла (без пути)
	hlnk_targets список	успех, путь существует	Список других файлов, ссылающихся на тот же файл (жёсткие ссылки), исключая текущий файл Пример: ['C:\\temp\\file.txt', 'C:\\Windows\\update.log']
	isarchive boolean	успех, путь существует	Подготовлен ли путь к архивированию Пример: True
	isdir boolean	успех, путь существует	Является ли путь каталогом Пример: True
	ishidden boolean	успех, путь существует	Скрыт ли путь Пример: True
	isjunction boolean	успех, путь существует	Является ли путь точкой сопряжения Пример: True
	islnk boolean	успех, путь существует	Является ли путь символической ссылкой Пример: True
	isreadonly boolean	успех, путь существует	Только для чтения Пример: True
	isreg boolean	успех, путь существует	Является ли путь обычным файлом Пример: True
	isshared boolean	успех, путь существует	Общий доступ Пример: True
	lastaccesstime число с плавающей точкой	успех, путь существует	Последнее время доступа к файлу, представленное в секундах с момента эпохи Пример: 1477984205.15
	lastwritetime число с плавающей точкой	успех, путь существует	Последнее время изменения файла, представленное в секундах с момента эпохи Пример: 1477984205.15
	lnk_source строка	успех, путь существует и является символической ссылкой или точкой сопряжения	Целевой объект symlink, нормализованный для удалённой файловой системы Пример: C:\temp\link
	lnk_target строка	успех, путь существует и является символической ссылкой или точкой сопряжения	Целевой объект symlink. Обратите внимание, что относительные пути остаются относительными Пример: ..\link
	md5 строка	успех, путь существует, путь — файл, get_md5 == True	Хеш-сумма MD5 файла (между Ansible 1.9 и 2.2 возвращалась как SHA1 хеш-сумма), будет удалена в версии 2.9 Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98
	nlink целое число	успех, путь существует	Количество ссылок на файл (жёсткие ссылки) Пример: 1
	owner строка	успех, путь существует	Владелец файла Пример: BUILTIN\Administrators
	path строка	успех, путь существует, файл существует	Полный абсолютный путь к файлу Пример: C:\foo.ini
	sharename строка	успех, путь существует, файл — каталог и isshared == True	Имя общего доступа, если папка общая Пример: file-share
	size целое число	успех, путь существует, файл не является ссылкой	Размер файла или папки в байтах Пример: 1024

Статус

Данный модуль гарантированно не будет содержать обратной совместимости в дальнейшем. [stableinterface]
Этот модуль поддерживается командой Ansible Core. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

Chris Church (@cchurch)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/win_stat_module.html