win_stat – Получение информации о файлах Windows
Описание
- Возвращает информацию о файле Windows.
- Для платформ, отличных от Windows, используйте модуль stat.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| checksum_algorithm строка добавлен в 2.3 |
| Алгоритм для определения контрольной суммы файла. Вызовет ошибку, если хост не поддерживает указанный алгоритм. |
| follow булево добавлен в 2.8 |
| Следовать ли ссылкам (символическим ссылкам и жёстким ссылкам). В случае path, ведущим к другой ссылке, ссылка будет следовать до тех пор, пока не будут найдены больше ссылок. |
| get_checksum булево добавлен в 2.1 |
| Возвращать ли контрольную сумму файла (по умолчанию sha1). |
| get_md5 булево |
| Возвращать ли контрольную сумму файла (MD5). В Ansible 1.9-2.2 это SHA1, в Ansible 2.3 - MD5 снова. Возвращает None, если хост не поддерживает указанный алгоритм. Значение по умолчанию этого параметра изменилось с yes на no в Ansible 2.5 и будет удалено в Ansible 2.9.Используйте get_checksum=yes с checksum_algorithm=md5 для возвращения md5 хеша в поле checksum. |
| path путь / обязательный | Полный путь к файлу/объекту, для которого необходимо получить информацию; допускаются как слэши «/», так и обратные слэши «\». псевдонимы: dest, name |
См. также
См. также
- stat – Получение статуса файла или файловой системы
- Официальная документация модуля stat.
- win_acl – Установка разрешений доступа к файлам/каталогам/регистру для системных пользователей или групп
- Официальная документация модуля win_acl.
- win_file – Создание, изменение или удаление файлов или каталогов
- Официальная документация модуля win_file.
- win_owner – Установка владельца
- Официальная документация модуля win_owner.
Примеры
- 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. Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98 | |
| creationtime вещественное число | успех, путь существует | Время создания файла в секундах с момента эпохи. Пример: 1477984205.15 | |
| exists boolean | успех | Существует ли путь или нет. Пример: True | |
| extension строка | успех, путь существует, путь является файлом | Расширение файла по пути. Пример: .ps1 | |
| filename строка | успех, путь существует, путь является файлом | Имя файла (без пути). Пример: foo.ini | |
| 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 и Ansible 2.2 это возвращалось как SHA1 хеш), будет удалено в Ansible 2.9. Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98 | |
| nlink целое число | успех, путь существует | Количество ссылок на файл (жесткие ссылки). Пример: 1 | |
| owner строка | успех, путь существует | Владелец файла. Пример: BUILTIN\Administrators | |
| path строка | успех, путь существует, файл существует | Полный абсолютный путь к файлу. Пример: C:\foo.ini | |
| sharename строка | успех, путь существует, файл является каталогом и isshared == True | Имя общего доступа, если папка общая. Пример: file-share | |
| size целое число | успех, путь существует, файл не является ссылкой | Размер файла или папки в байтах. Пример: 1024 | |
Статус
- Гарантируется, что в этом модуле не будет несовместимых изменений интерфейса в будущем. [stableinterface]
- Этот модуль поддерживается командой разработчиков Ansible. [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.8/modules/win_stat_module.html