Spec-Zone.ru › Ansible 2.4

stat - Получение состояния файла или файловой системы

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

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Состояние
    • Информация о техническом обслуживании

Описание

  • Получает информацию о файле, аналогично команде linux/unix ‘stat’.
  • Для систем Windows используйте модуль win_stat.

Параметры

параметр обязательно по умолчанию возможные значения комментарии
checksum_algorithm
(добавлен в 2.0)
нет sha1
  • sha1
  • sha224
  • sha256
  • sha384
  • sha512
Алгоритм для определения контрольной суммы файла. Вызовет ошибку, если хост не поддерживает указанный алгоритм.
псевдонимы: checksum, checksum_algo
follow
нет нет
  • нет
  • да
Следовать ли символичным ссылкам.
get_attributes
(добавлен в 2.3)
нет да
  • нет
  • да
Получить атрибуты файла с помощью инструмента lsattr, если он доступен.
псевдонимы: attr, attributes
get_checksum
(добавлен в 1.8)
нет да
  • нет
  • да
Возвращать ли контрольную сумму файла (по умолчанию sha1).
get_md5
нет да
  • нет
  • да
Возвращать ли md5 сумму файла.
Вернет None, если это не обычный файл или если мы не можем использовать md5 (часто встречается на системах, совместимых с FIPS-140).
get_mime
(добавлен в 2.1)
нет да
  • нет
  • да
Использовать магию файлов и вернуть данные о природе файла. Использует утилиту 'file', которая есть на большинстве систем Linux/Unix.
Добавит поля `mime_type` и 'charset' в результат, если возможно.
В версии 2.3 этот параметр изменился с 'mime' на 'get_mime', а значение по умолчанию изменилось на 'да'.
псевдонимы: mime, mime_type, mime-type
path
да
Полный путь к файлу/объекту, для которого необходимо получить информацию.

Примеры

# 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

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

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

name description returned type sample
stat
словарь, содержащий все данные stat, некоторые платформы могут добавлять дополнительные поля
success complex
contains:
name description returned type sample
isuid
Указывает, соответствует ли идентификатор пользователя, вызывающего метод, идентификатору владельца
success, путь существует и пользователь может читать статистику boolean False
uid
Числовой идентификатор, представляющий владельца файла
success, путь существует и пользователь может читать статистику int 1003
exists
указывает, существует ли фактически целевой путь или нет
success boolean True
lnk_target
Целевой путь символической ссылки. Обратите внимание, что относительные пути остаются относительными
success, путь существует и пользователь может читать статистику, и путь является символической ссылкой string ../foobar/21102015-1445431274-908472971
woth
Указывает, имеют ли другие права на запись
success, путь существует и пользователь может читать статистику boolean False
mtime
Время последнего изменения
success, путь существует и пользователь может читать статистику float 1424348972.58
inode
Номер узла пути
success, путь существует и пользователь может читать статистику int 12758
isgid
Указывает, соответствует ли идентификатор группы вызывающего пользователя идентификатору группы владельца
success, путь существует и пользователь может читать статистику boolean False
size
Размер в байтах для обычного файла, количество данных для некоторых специальных файлов
success, путь существует и пользователь может читать статистику int 203
wgrp
Указывает, имеет ли группа владельца права на запись
success, путь существует и пользователь может читать статистику boolean False
executable
Указывает, имеет ли вызывающий пользователь право выполнить путь
success, путь существует и пользователь может выполнить путь boolean False
charset
кодировка символов файла
success, путь существует и пользователь может читать статистику, установленный Python поддерживает её, и опция `mime` была true, вернёт 'unknown' при ошибке. string us-ascii
readable
Указывает, имеет ли вызывающий пользователь право читать путь
success, путь существует и пользователь может прочитать путь boolean False
isreg
Указывает, является ли путь обычным файлом
success, путь существует и пользователь может читать статистику boolean True
pw_name
Имя пользователя владельца
success, путь существует и пользователь может читать статистику, установленный Python поддерживает её string httpd
gid
Числовой идентификатор, представляющий группу владельца
success, путь существует и пользователь может читать статистику int 1003
ischr
Указывает, является ли путь символьным устройством
success, путь существует и пользователь может читать статистику boolean False
mime_type
магические данные файла или mime-тип
success, путь существует и пользователь может читать статистику, установленный Python поддерживает её, и опция `mime` была true, вернёт 'unknown' при ошибке. string PDF document, version 1.2
wusr
Указывает, имеет ли владелец права на запись
success, путь существует и пользователь может читать статистику boolean True
writeable
Указывает, имеет ли вызывающий пользователь право записать путь
success, путь существует и пользователь может записать путь boolean False
xoth
Указывает, имеют ли другие права на выполнение
success, путь существует и пользователь может читать статистику boolean True
rusr
Указывает, имеет ли владелец права на чтение
success, путь существует и пользователь может читать статистику boolean True
nlink
Количество ссылок на узел (жёсткие ссылки)
success, путь существует и пользователь может читать статистику int 1
issock
Указывает, является ли путь сокетом доменной Unix
success, путь существует и пользователь может читать статистику boolean False
rgrp
Указывает, имеет ли группа владельца права на чтение
success, путь существует и пользователь может читать статистику boolean True
gr_name
Имя группы владельца
success, путь существует и пользователь может читать статистику, установленный Python поддерживает её string www-data
path
Полный путь к файлу/объекту, для которого нужно получить информацию
success и если путь существует string /path/to/file
xusr
Указывает, имеет ли владелец права на выполнение
success, путь существует и пользователь может читать статистику boolean True
atime
Время последнего доступа
success, путь существует и пользователь может читать статистику float 1424348972.58
lnk_source
Целевой путь символической ссылки, нормализованный для удалённой файловой системы
success, путь существует и пользователь может читать статистику, и путь является символической ссылкой string /home/foobar/21102015-1445431274-908472971
md5
md5 хэш пути
success, путь существует и пользователь может читать статистику, путь поддерживает хеширование и md5 поддерживается string f88fa92d8cf2eeecf4c0a50ccc96d0c0
isdir
Указывает, является ли путь каталогом
success, путь существует и пользователь может читать статистику boolean False
ctime
Время последнего обновления или создания метаданных (зависит от ОС)
success, путь существует и пользователь может читать статистику float 1424348972.58
isblk
Указывает, является ли путь блочным устройством
success, путь существует и пользователь может читать статистику boolean False
xgrp
Указывает, имеет ли группа владельца права на выполнение
success, путь существует и пользователь может читать статистику boolean True
dev
Устройство, на котором находится узел
success, путь существует и пользователь может читать статистику int 33
roth
Указывает, имеют ли другие права на чтение
success, путь существует и пользователь может читать статистику boolean True
isfifo
Указывает, является ли путь именованной пайп
success, путь существует и пользователь может читать статистику boolean False
mode
Unix-разрешения файла в восьмеричной форме
success, путь существует и пользователь может читать статистику octal 1755
checksum
хэш пути
success, путь существует, пользователь может читать статистику, путь поддерживает хеширование и алгоритм хеширования предоставлен string 50ba294cdf28c0d5bcde25708df53346825a429f
islnk
Указывает, является ли путь символической ссылкой
success, путь существует и пользователь может читать статистику boolean False
attributes
список атрибутов файла
success, путь существует и пользователь может выполнить путь list ['immutable', 'extent']

Примечания

Примечание

  • Для платформ Windows используйте модуль win_stat вместо этого.

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будут вноситься изменения в интерфейс, несовместимые с предыдущими версиями.

Информация о техническом обслуживании

Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти по адресу knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

Для получения помощи в разработке модулей, если у вас есть желание, прочитайте Информацию и вклад сообщества, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API