win_stat - возвращает информацию о файле Windows
Новая версия с 1.7.
Описание
- Возвращает информацию о файле Windows.
- Для платформ, не являющихся Windows, используйте модуль stat.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| checksum_algorithm (добавлено в 2.3) |
| Алгоритм для определения контрольной суммы файла. Вызовет ошибку, если хост не поддерживает указанный алгоритм. |
| get_checksum (добавлено в 2.1) |
| Нужно ли вернуть контрольную сумму файла (по умолчанию sha1) |
| get_md5 |
| Нужно ли вернуть контрольную сумму файла. В 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 обязательно | Полный путь к файлу/объекту, для которого нужно получить информацию; допускаются как слэши "/", так и обратные слэши "\". |
Примечания
Примечание
- Для платформ, не являющихся 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 | |
| exists boolean | успех | Существует ли путь или нет Пример: True | |
| lnk_target string | успех, путь существует и является символической ссылкой или точкой соединения | Целевой объект символической ссылки. Обратите внимание, что относительные пути остаются относительными Пример: ..\link | |
| lastwritetime float | успех, путь существует | Время последнего изменения файла, представленное в секундах с момента эпохи Пример: 1477984205.15 | |
| creationtime float | успех, путь существует | Время создания файла, представленное в секундах с момента эпохи Пример: 1477984205.15 | |
| lastaccesstime float | успех, путь существует | Время последнего доступа к файлу, представленное в секундах с момента эпохи Пример: 1477984205.15 | |
| nlink int | успех, путь существует | Количество ссылок на файл (жёсткие ссылки) Пример: 1 | |
| owner string | успех, путь существует | Владелец файла Пример: BUILTIN\Administrators | |
| path string | успех, путь существует, файл существует | Полный абсолютный путь к файлу Пример: C:\foo.ini | |
| isarchive boolean | успех, путь существует | Готов ли путь к архивированию Пример: True | |
| ishidden boolean | успех, путь существует | Скрыт ли путь Пример: True | |
| lnk_source string | успех, путь существует и является символической ссылкой или точкой соединения | Целевой объект символической ссылки, нормализованный для удалённой файловой системы Пример: C:\temp\link | |
| size int | успех, путь существует, файл не является ссылкой | Размер файла или папки в байтах Пример: 1024 | |
| isdir boolean | успех, путь существует | Является ли путь каталогом Пример: True | |
| extension string | успех, путь существует, путь является файлом | Расширение файла по пути Пример: .ps1 | |
| isreadonly boolean | успех, путь существует | Только чтение или нет Пример: True | |
| sharename string | успех, путь существует, файл является каталогом и isshared == True | Имя общего ресурса, если папка доступна по сети Пример: file-share | |
| isjunction boolean | успех, путь существует | Является ли путь точкой соединения Пример: True | |
| filename string | успех, путь существует, путь является файлом | Имя файла (без пути) | |
| isreg boolean | успех, путь существует | Является ли путь обычным файлом Пример: True | |
| hlnk_targets list | успех, путь существует | Список других файлов, ссылающихся на тот же файл (жёсткие ссылки), исключая текущий файл Пример: ['C:\\temp\\file.txt', 'C:\\Windows\\update.log'] | |
| checksum string | успех, путь существует, путь является файлом, get_checksum == True, указанный алгоритм checksum поддерживается | Хеш-сумма файла, основанная на указанном алгоритме checksum Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98 | |
| islnk boolean | успех, путь существует | Является ли путь символической ссылкой Пример: True | |
| attributes string | успех, путь существует | Атрибуты файла по пути в сыром виде Пример: Архив, Скрытый | |
| isshared boolean | успех, путь существует | Доступен ли путь по сети Пример: True | |
| md5 string | успех, путь существует, путь является файлом, get_md5 == True | Хеш-сумма MD5 файла (между Ansible 1.9 и 2.2 возвращался как SHA1 хеш), будет удалён в 2.9 Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98 | |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией 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.5/modules/win_stat_module.html
