Spec-Zone.ru › Ansible 2.8

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

  • Описание
  • Параметры
  • См. также
  • Примеры
  • Возвращаемые значения
  • Состояние

Описание

  • Получает данные о файле, аналогично команде Linux/Unix ‘stat’.
  • Для целевых систем Windows используйте модуль win_stat.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
checksum_algorithm
строка
добавлен в 2.0
    Варианты:
  • md5
  • sha1 ←
  • sha224
  • sha256
  • sha384
  • sha512
Алгоритм для определения контрольной суммы файла.
Возникает ошибка, если хост не может использовать указанный алгоритм.
Удаленный хост должен поддерживать указанный метод хэширования, md5 может быть недоступен, если хост соответствует FIPS-140.

псевдонимы: checksum, checksum_algo
follow
логическое значение
    Варианты:
  • no ←
  • yes
Следовать ли символичным ссылкам.
get_attributes
логическое значение
добавлен в 2.3
    Варианты:
  • no
  • yes ←
Получить атрибуты файла с помощью инструмента lsattr, если он присутствует.

псевдонимы: attr, attributes
get_checksum
логическое значение
    Варианты:
  • no
  • yes ←
Возвращать ли контрольную сумму файла.
get_md5
логическое значение
    Варианты:
  • no ←
  • yes
Возвращать ли сумму 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
    Варианты:
  • no
  • yes ←
Использовать магическое число файлов и возвращать данные о природе файла. Использует утилиту 'file', присутствующую в большинстве систем Linux/Unix.
Добавит поля `mime_type` и 'charset' в возвращаемые данные, если возможно.
В Ansible 2.3 этот параметр изменился с 'mime' на 'get_mime', а значение по умолчанию изменилось на 'Yes'.

псевдонимы: mime, mime_type, mime-type
path
путь / обязательно
Полный путь к файлу/объекту, для которого необходимо получить данные.

См. также

См. также

file – Управление файлами и свойствами файлов
Официальная документация модуля file.
win_stat – Получение информации о файлах 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 checksum
- stat:
    path: /path/to/myhugefile
    get_checksum: no

# Use sha256 to calculate checksum
- stat:
    path: /path/to/something
    checksum_algorithm: sha256

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

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

Ключ Возвращаемое значение Описание
stat
сложный
успех
словарь, содержащий все данные stat, некоторые платформы могут добавить дополнительные поля

atime
float
успех, путь существует и пользователь может прочитать статистику
Время последнего доступа

Пример:
1424348972.575
attributes
список
добавлен в 2.3
успех, путь существует и пользователь может выполнить путь
список атрибутов файла

Пример:
['immutable', 'extent']
charset
строка
успех, путь существует и пользователь может прочитать статистику, установленный Python поддерживает это, и опция `mime` была true, в случае ошибки вернет 'unknown'.
кодировка или набор символов файла

Пример:
us-ascii
checksum
строка
успех, путь существует, пользователь может прочитать статистику, путь поддерживает хэширование и предоставленный алгоритм хэширования доступен
хеш пути

Пример:
50ba294cdf28c0d5bcde25708df53346825a429f
ctime
float
успех, путь существует и пользователь может прочитать статистику
Время последнего обновления или создания метаданных (зависит от ОС)

Пример:
1424348972.575
dev
целое число
успех, путь существует и пользователь может прочитать статистику
Устройство, на котором находится индексный дескриптор

Пример:
33
executable
булево
добавлен в 2.2
успех, путь существует и пользователь может выполнить путь
Указывает, может ли вызывающий пользователь выполнить путь

exists
булево
успех
Существует ли фактически путь назначения или нет

Пример:
True
gid
целое число
успех, путь существует и пользователь может прочитать статистику
Числовое id, представляющее группу владельца

Пример:
1003
gr_name
строка
успех, путь существует и пользователь может прочитать статистику и установленный Python поддерживает это
Имя группы владельца

Пример:
www-data
inode
целое число
успех, путь существует и пользователь может прочитать статистику
Номер индексного дескриптора пути

Пример:
12758
isblk
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь блочным устройством

ischr
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь символьным устройством

isdir
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь каталогом

isfifo
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь именованной трубой

isgid
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, совпадает ли идентификатор группы вызывающего пользователя с идентификатором группы владельца

islnk
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь символической ссылкой

isreg
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь обычным файлом

Пример:
True
issock
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, является ли путь сокетом Unix-домена

isuid
булево
успех, путь существует и пользователь может прочитать статистику
Указывает, совпадает ли идентификатор пользователя вызывающего пользователя с идентификатором владельца

lnk_source
строка
успех, путь существует и пользователь может прочитать статистику, и путь является символической ссылкой
Цель символической ссылки, нормализованная для удаленной файловой системы

Пример:
/home/foobar/21102015-1445431274-908472971
lnk_target
строка
добавлен в 2.4
успех, путь существует и пользователь может прочитать статистику, и путь является символической ссылкой
Цель символической ссылки. Обратите внимание, что относительные пути остаются относительными

Пример:
../foobar/21102015-1445431274-908472971
md5
строка
успех, путь существует и пользователь может прочитать статистику и путь поддерживает хэширование и md5 поддерживается
md5 хеш пути; это будет удалено в Ansible 2.9 в пользу значения возвращаемого хеша

Пример:
f88fa92d8cf2eeecf4c0a50ccc96d0c0
mimetype
строка
успех, путь существует и пользователь может прочитать статистику, установленный Python поддерживает это, и опция `mime` была true, в случае ошибки вернет 'unknown'.
магические данные файла или тип mime

Пример:
application/pdf; charset=binary
mode
строка
успех, путь существует и пользователь может прочитать статистику
Unix разрешения файла в восьмеричном представлении в виде строки

Пример:
1755
mtime
float
успех, путь существует и пользователь может прочитать статистику
Время последнего изменения

Пример:
1424348972.575
nlink
целое число
успех, путь существует и пользователь может прочитать статистику
Количество ссылок на индексный дескриптор (жесткие ссылки)

Пример:
1
path
строка
успех и если путь существует
Полный путь файла/объекта, для которого нужно получить информацию

Пример:
/path/to/file
pw_name
строка
успех, путь существует, и пользователь может читать статистику, и установленный Python ее поддерживает
Имя пользователя владельца

Пример:
httpd
readable
булево
добавлено в 2.2
успех, путь существует, и пользователь может читать путь
Указывает, имеет ли вызывающий пользователь право на чтение пути

rgrp
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеет ли группа владельца право на чтение

Пример:
True
roth
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеют ли другие право на чтение

Пример:
True
rusr
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеет ли владелец право на чтение

Пример:
True
size
целое число
успех, путь существует, и пользователь может читать статистику
Размер в байтах для обычного файла, количество данных для некоторых специальных файлов

Пример:
203
uid
целое число
успех, путь существует, и пользователь может читать статистику
Числовой идентификатор, представляющий владельца файла

Пример:
1003
wgrp
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеет ли группа владельца право на запись

woth
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеют ли другие право на запись

writeable
булево
добавлено в 2.2
успех, путь существует, и пользователь может записывать в путь
Указывает, имеет ли вызывающий пользователь право на запись в путь

wusr
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеет ли владелец право на запись

Пример:
True
xgrp
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеет ли группа владельца право на выполнение

Пример:
True
xoth
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеют ли другие право на выполнение

Пример:
True
xusr
булево
успех, путь существует, и пользователь может читать статистику
Указывает, имеет ли владелец право на выполнение

Пример:
True


Статус

  • Гарантируется, что в этом модуле не будет изменений интерфейса, несовместимых со старыми версиями. [stableinterface]
  • Этот модуль поддерживается основной командой Ansible. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье из базы знаний Red Hat.

Авторы

  • Bruce Pennypacker (@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.8/modules/stat_module.html

Spec-Zone.ru

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