win_stat – Получение информации о файлах Windows
Синопсис
- Возвращает информацию о файле Windows.
- Для платформ, не являющихся Windows, используйте модуль stat.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| checksum_algorithm строка |
| Алгоритм для определения контрольной суммы файла. Возникнет ошибка, если хост не поддерживает указанный алгоритм. |
| follow булево добавлен в 2.8 |
| Следовать ли ссылкам (символическим ссылкам или соединениям) или нет. В случае с path, указывающим на другую ссылку, будет происходить переадресация, пока не будут найдены все ссылки. |
| get_checksum булево |
| Возвращать ли контрольную сумму файла (по умолчанию sha1) |
| get_md5 булево |
| Возвращать ли контрольную сумму файла в формате MD5. Между Ansible 1.9 и Ansible 2.2 это больше не MD5, а 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 string | успех, путь существует | Атрибуты файла по пути в сыром виде. Пример: Архив, Скрытый | |
| checksum string | успех, путь существует, путь является файлом, get_checksum == True, заданный алгоритм checksum поддерживается | Контрольная сумма файла, основанная на указанном алгоритме checksum. Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98 | |
| creationtime float | успех, путь существует | Время создания файла, представленное в секундах с эпохи. Пример: 1477984205.15 | |
| exists boolean | успех | Существует ли путь или нет. Пример: True | |
| extension string | успех, путь существует, путь является файлом | Расширение файла по пути. Пример: .ps1 | |
| filename string | успех, путь существует, путь является файлом | Имя файла (без пути). Пример: foo.ini | |
| hlnk_targets list | успех, путь существует | Список других файлов, ссылающихся на тот же файл (жёсткие ссылки), исключая текущий файл. Пример: ['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 float | успех, путь существует | Последнее время доступа к файлу, представленное в секундах с эпохи. Пример: 1477984205.15 | |
| lastwritetime float | успех, путь существует | Последнее время изменения файла, представленное в секундах с эпохи. Пример: 1477984205.15 | |
| lnk_source string | успех, путь существует, и путь является символической ссылкой или точкой сопряжения | Целевой путь символической ссылки, нормализованный для удалённой файловой системы. Пример: C:\temp\link | |
| lnk_target string | успех, путь существует, и путь является символической ссылкой или точкой сопряжения | Целевой путь символической ссылки. Обратите внимание, что относительные пути остаются относительными. Пример: ..\link | |
| md5 string | успех, путь существует, путь является файлом, get_md5 == True | Контрольная сумма MD5 файла (между Ansible 1.9 и Ansible 2.2 это возвращалась как хэш SHA1), будет удалена в Ansible 2.9. Пример: 09cb79e8fc7453c84a07f644e441fd81623b7f98 | |
| nlink integer | успех, путь существует | Количество ссылок на файл (жёсткие ссылки). Пример: 1 | |
| owner string | успех, путь существует | Владелец файла. Пример: BUILTIN\Administrators | |
| path string | успех, путь существует, файл существует | Полный абсолютный путь к файлу. Пример: C:\foo.ini | |
| sharename string | успех, путь существует, файл является каталогом и isshared == True | Имя общего ресурса, если папка общая. Пример: file-share | |
| size integer | успех, путь существует, файл не является ссылкой | Размер файла или папки в байтах. Пример: 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.9/modules/win_stat_module.html