stat - Получение статуса файла или файловой системы
Новое в версии 1.3.
Описание
- Получает информацию о файле, аналогично команде linux/unix ‘stat’.
- Для целевых систем Windows используйте модуль win_stat.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| checksum_algorithm (добавлено в 2.0) |
| Алгоритм для определения контрольной суммы файла. Вызовет ошибку, если хост не поддерживает указанный алгоритм. Удаленный хост должен поддерживать указанный метод хэширования, md5 может быть недоступен, если хост соответствует стандарту FIPS-140.псевдонимы: checksum, checksum_algo |
| follow |
| Следовать ли символическим ссылкам. |
| get_attributes (добавлено в 2.3) |
| Получить атрибуты файла с помощью утилиты lsattr, если она доступна. псевдонимы: attr, attributes |
| get_checksum (добавлено в 1.8) |
| Возвращать ли контрольную сумму файла (по умолчанию sha1). |
| get_md5 |
| Возвращать ли md5 сумму файла. Вернёт None, если файл не является обычным файлом или если невозможно использовать md5 (часто встречается на системах, соответствующих FIPS-140). По умолчанию этот параметр изменился с yes на no в Ansible 2.5 и будет полностью удален в Ansible 2.9.Используйте get_checksum=true с checksum_algorithm=md5 для возврата md5 хэша в значении возврата checksum. |
| get_mime (добавлено в 2.1) |
| Использовать магию файлов и вернуть данные о типе файла. Использует утилиту 'file', доступную на большинстве систем Linux/Unix. Это добавит поля `mime_type` и 'charset' в результат, если возможно. В версии 2.3 этот параметр изменился с 'mime' на 'get_mime', а значение по умолчанию изменилось на 'Да'. псевдонимы: mime, mime_type, mime-type |
| path обязательно | Полный путь к файлу/объекту, для которого нужно получить информацию. |
Примечания
Примечание
- Для целевых систем Windows используйте модуль win_stat.
Примеры
# Obtain the stats of /etc/foo.conf, and check that the file still belongs
# to 'root'. Fail otherwise.
- stat:
path: /etc/foo.conf
register: st
- fail:
msg: "Whoops! file ownership has changed"
when: st.stat.pw_name != 'root'
# Determine if a path exists and is a symlink. Note that if the path does
# not exist, and we test sym.stat.islnk, it will fail with an error. So
# therefore, we must test whether it is defined.
# Run this to understand the structure, the skipped ones do not pass the
# check performed by 'when'
- stat:
path: /path/to/something
register: sym
- debug:
msg: "islnk isn't defined (path doesn't exist)"
when: sym.stat.islnk is not defined
- debug:
msg: "islnk is defined (path must exist)"
when: sym.stat.islnk is defined
- debug:
msg: "Path exists and is a symlink"
when: sym.stat.islnk is defined and sym.stat.islnk
- debug:
msg: "Path exists and isn't a symlink"
when: sym.stat.islnk is defined and sym.stat.islnk == False
# Determine if a path exists and is a directory. Note that we need to test
# both that p.stat.isdir actually exists, and also that it's set to true.
- stat:
path: /path/to/something
register: p
- debug:
msg: "Path exists and is a directory"
when: p.stat.isdir is defined and p.stat.isdir
# Don't do md5 checksum
- stat:
path: /path/to/myhugefile
get_md5: no
# Use sha256 to calculate checksum
- stat:
path: /path/to/something
checksum_algorithm: sha256
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| stat сложный тип | успех | словарь, содержащий все данные stat, некоторые платформы могут добавить дополнительные поля | |
| isuid булево | успех, путь существует и пользователь может читать статистику | Указывает, совпадает ли идентификатор вызывающего пользователя с идентификатором владельца | |
| uid целое число | успех, путь существует и пользователь может читать статистику | Числовой идентификатор, представляющий владельца файла Пример: 1003 | |
| exists булево | успех | указывает, существует ли целевой путь Пример: True | |
| lnk_target строка | успех, путь существует и пользователь может читать статистику, и путь является символьной ссылкой | Цель символьной ссылки. Обратите внимание, что относительные пути остаются относительными Пример: ../foobar/21102015-1445431274-908472971 | |
| woth булево | успех, путь существует и пользователь может читать статистику | Указывает, имеют ли другие права записи | |
| mtime вещественное число | успех, путь существует и пользователь может читать статистику | Время последнего изменения Пример: 1424348972.58 | |
| inode целое число | успех, путь существует и пользователь может читать статистику | Номер узла пути Пример: 12758 | |
| isgid булево | успех, путь существует и пользователь может читать статистику | Указывает, совпадает ли группа вызывающего пользователя с группой владельца | |
| size целое число | успех, путь существует и пользователь может читать статистику | Размер в байтах для обычного файла, объем данных для некоторых специальных файлов Пример: 203 | |
| wgrp булево | успех, путь существует и пользователь может читать статистику | Указывает, имеет ли группа владельца права на запись | |
| executable булево | успех, путь существует и пользователь может выполнить путь | Указывает, имеет ли вызывающий пользователь право выполнить путь | |
| charset строка | успех, путь существует и пользователь может читать статистику и установленный python поддерживает его, и параметр `mime` был true, в противном случае вернёт 'unknown'. | Набор символов или кодировка файла Пример: us-ascii | |
| readable булево | успех, путь существует и пользователь может прочитать путь | Указывает, имеет ли вызывающий пользователь право чтения пути | |
| isreg булево | успех, путь существует и пользователь может читать статистику | Указывает, является ли путь обычным файлом Пример: True | |
| pw_name строка | успех, путь существует и пользователь может читать статистику и установленный python поддерживает её | Имя пользователя владельца Пример: httpd | |
| gid целое число | успех, путь существует и пользователь может читать статистику | Числовой идентификатор, представляющий группу владельца Пример: 1003 | |
| ischr булево | успех, путь существует и пользователь может читать статистику | Указывает, является ли путь символьным устройством | |
| mime_type строка | успех, путь существует и пользователь может читать статистику, установленный python поддерживает её, и параметр `mime` был true, в противном случае вернёт 'unknown'. | Магические данные файла или тип MIME Пример: PDF document, version 1.2 | |
| wusr булево | успех, путь существует и пользователь может читать статистику | Указывает, имеет ли владелец права на запись Пример: True | |
| writeable булево | успех, путь существует и пользователь может записать в путь | Указывает, имеет ли вызывающий пользователь право записи в путь | |
| xoth булево | успех, путь существует и пользователь может читать статистику | Указывает, имеют ли другие права выполнения Пример: True | |
| rusr булево | успех, путь существует и пользователь может читать статистику | Указывает, имеет ли владелец права на чтение Пример: True | |
| nlink целое число | успех, путь существует и пользователь может читать статистику | Количество ссылок на узел (жёсткие ссылки) Пример: 1 | |
| issock булево | успех, путь существует и пользователь может читать статистику | Указывает, является ли путь сокетом Unix-домена | |
| rgrp булево | успех, путь существует и пользователь может читать статистику | Указывает, имеет ли группа владельца права на чтение Пример: True | |
| gr_name строка | успех, путь существует и пользователь может читать статистику и установленный python поддерживает её | Имя группы владельца Пример: www-data | |
| path строка | успех и если путь существует | Полный путь к файлу/объекту, для которого нужно получить данные Пример: /path/to/file | |
| xusr булево | успех, путь существует и пользователь может читать статистику | Указывает, имеет ли владелец права на выполнение Пример: True | |
| atime вещественное число | успех, путь существует и пользователь может читать статистику | Время последнего доступа Пример: 1424348972.58 | |
| lnk_source строка | успех, путь существует, пользователь может читать статистику, и путь — символическая ссылка | Нормализованная цель символической ссылки для удалённой файловой системы Пример: /home/foobar/21102015-1445431274-908472971 | |
| md5 строка | успех, путь существует, пользователь может читать статистику, и путь поддерживает хеширование, а md5 поддерживается | Хеш md5 пути; это будет удалено в Ansible 2.9 в пользу значения возвращаемого контрольной суммы Пример: f88fa92d8cf2eeecf4c0a50ccc96d0c0 | |
| isdir логическое значение | успех, путь существует, и пользователь может читать статистику | Указывает, является ли путь каталогом | |
| ctime вещественное число | успех, путь существует, и пользователь может читать статистику | Время последнего обновления или создания метаданных (зависит от ОС) Пример: 1424348972.58 | |
| isblk логическое значение | успех, путь существует, и пользователь может читать статистику | Указывает, является ли путь блочным устройством | |
| xgrp логическое значение | успех, путь существует, и пользователь может читать статистику | Указывает, имеет ли группа владельца разрешение на выполнение Пример: True | |
| dev целое число | успех, путь существует, и пользователь может читать статистику | Устройство, на котором находится inode Пример: 33 | |
| roth логическое значение | успех, путь существует, и пользователь может читать статистику | Указывает, имеют ли другие разрешение на чтение Пример: True | |
| isfifo логическое значение | успех, путь существует, и пользователь может читать статистику | Указывает, является ли путь именованной очередью | |
| mode восьмеричное | успех, путь существует, и пользователь может читать статистику | Разрешения Unix файла в восьмеричном формате Пример: 1755 | |
| checksum строка | успех, путь существует, пользователь может читать статистику, путь поддерживает хеширование и алгоритм контрольной суммы доступен | Хеш пути Пример: 50ba294cdf28c0d5bcde25708df53346825a429f | |
| islnk логическое значение | успех, путь существует, и пользователь может читать статистику | Указывает, является ли путь символической ссылкой | |
| attributes список | успех, путь существует, и пользователь может выполнить путь | Список атрибутов файла Пример: ['immutable', 'extent'] |
Статус
Этот модуль помечен как stableinterface, что означает, что поддерживающие этот модуль гарантируют, что не будут вноситься несовместимые с обратной совместимостью изменения интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний
Автор
- Брюс Пеннипэкер (@bpennypacker)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/stat_module.html