Модуль community.windows.win_disk_facts — отображение подключённых дисков и информации о дисках целевого хоста
Примечание
Этот модуль входит в коллекцию community.windows (версия 3.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.windows. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.windows.win_disk_facts.
Краткое описание
- С помощью этого модуля можно получить и вывести подробную информацию о подключённых дисках целевого хоста, а также о его томах и разделах, если они имеются.
Требования
На хосте, где выполняется этот модуль, необходимы следующие компоненты.
- Windows 8.1 / Windows 2012 (NT 6.2)
Параметры
Параметр | Комментарии |
|---|---|
filter list / elements=string добавлено в community.windows 1.9.0 | Позволяет фильтровать возвращаемые факты по типу информации о диске. Если выбраны тома, будут также возвращены разделы. Варианты:
Значение по умолчанию: |
Примечания
Примечание
- Чтобы понять все возвращаемые свойства и значения, перейдите на следующий сайт и откройте соответствующий класс MSFT: https://msdn.microsoft.com/en-us/library/windows/desktop/hh830612.aspx
Примеры
- name: Get disk facts
community.windows.win_disk_facts:
- name: Output first disk size
debug:
var: ansible_facts.disks[0].size
- name: Convert first system disk into various formats
debug:
msg: '{{ disksize_gib }} vs {{ disksize_gib_human }}'
vars:
# Get first system disk
disk: '{{ ansible_facts.disks|selectattr("system_disk")|first }}'
# Show disk size in Gibibytes
disksize_gib_human: '{{ disk.size|filesizeformat(true) }}' # returns "223.6 GiB" (human readable)
disksize_gib: '{{ (disk.size/1024|pow(3))|round|int }} GiB' # returns "224 GiB" (value in GiB)
# Show disk size in Gigabytes
disksize_gb_human: '{{ disk.size|filesizeformat }}' # returns "240.1 GB" (human readable)
disksize_gb: '{{ (disk.size/1000|pow(3))|round|int }} GB' # returns "240 GB" (value in GB)
- name: Output second disk serial number
debug:
var: ansible_facts.disks[1].serial_number
- name: get disk physical_disk and partition facts on the target
win_disk_facts:
filter:
- physical_disk
- partitions
Возвращаемые факты
Факты, возвращаемые этим модулем, добавляются/обновляются в фактах узла hostvars и могут использоваться по имени так же, как любые другие факты узла. Для их использования не требуется регистрация.
Ключ | Описание |
|---|---|
ansible_disks list / elements=string | Подробная информация об одном диске. Возвращается: если найдены диски |
|
bootable boolean |
Сведения о том, является ли данный диск загрузочным. Возвращается: всегда Пример: |
|
bus_type string |
Тип шины данного диска. Возвращается: всегда Пример: |
|
clustered boolean |
Сведения о том, входит ли данный диск в кластер (является ли частью отказоустойчивого кластера). Возвращается: всегда Пример: |
|
firmware_version string |
Версия прошивки данного диска. Возвращается: всегда Пример: |
|
friendly_name string | Понятное имя данного диска. Возвращается: всегда Пример: |
|
guid string |
GUID данного диска на целевом узле. Возвращается: если существует Пример: |
|
location string |
Расположение данного диска на целевом узле. Возвращается: всегда Пример: |
|
manufacturer string |
Производитель данного диска. Возвращается: всегда Пример: |
|
model string |
Характеристики модели данного диска. Возвращается: всегда Пример: |
|
number integer |
Номер данного диска. Возвращается: всегда Пример: |
|
operational_status string |
Рабочее состояние данного диска. Возвращается: всегда Пример: |
|
partition_count integer |
Количество разделов на данном диске. Возвращается: всегда Пример: |
|
partition_style string |
Стиль разделов данного диска. Возвращается: всегда Пример: |
|
partitions list / elements=string |
Подробная информация об одном разделе указанного диска. Возвращается: если существует |
|
access_paths string |
Пути доступа к данному разделу. Возвращается: если существует Пример: |
|
active boolean |
Сведения о том, является ли данный раздел активным. Возвращается: если свойство partition_style данного диска имеет значение «MBR» Пример: |
|
drive_letter string |
Буква диска данного раздела. Возвращается: если существует Пример: |
|
gpt_type string |
Тип GPT данного раздела. Возвращается: если свойство partition_style данного диска имеет значение «GPT» Пример: |
|
guid string |
GUID данного раздела. Возвращается: если существует Пример: |
|
boolean |
Сведения о том, является ли данный раздел скрытым. Возвращается: всегда Пример: |
|
mbr_type integer |
Тип MBR данного раздела. Возвращается: если свойство partition_style данного диска имеет значение «MBR» Пример: |
|
no_default_driveletter boolean |
Сведения о том, назначена ли данному разделу буква диска по умолчанию. Возвращается: если свойство partition_style данного диска имеет значение «GPT» Пример: |
|
number integer |
Номер данного раздела. Возвращается: всегда Пример: |
|
offset integer |
Смещение данного раздела. Возвращается: всегда Пример: |
|
shadow_copy boolean |
Сведения о том, является ли данный раздел теневой копией другого раздела. Возвращается: всегда Пример: |
|
size integer |
Размер данного раздела в байтах. Возвращается: всегда Пример: |
|
transition_state integer |
Состояние перехода данного раздела. Возвращается: всегда Пример: |
|
type string |
Тип данного раздела. Возвращается: всегда Пример: |
|
volumes list / elements=string |
Подробная информация об одном томе на указанном разделе. Возвращается: если существует |
|
allocation_unit_size integer |
Размер единицы распределения данного тома в байтах. Возвращается: всегда Пример: |
|
drive_type string |
Тип диска данного тома. Возвращается: всегда Пример: |
|
health_status string |
Состояние работоспособности данного тома. Возвращается: всегда Пример: |
|
label string |
Метка файловой системы данного тома. Возвращается: всегда Пример: |
|
object_id string |
Идентификатор объекта данного тома. Возвращается: всегда Пример: |
|
path string |
Путь к данному тому. Возвращается: всегда Пример: |
|
size integer |
Размер данного тома в байтах. Возвращается: всегда Пример: |
|
size_remaining integer |
Оставшийся размер данного тома в байтах. Возвращается: всегда Пример: |
|
type string |
Тип файловой системы данного тома. Возвращается: всегда Пример: |
|
path string |
Путь к данному диску на целевом узле. Возвращается: всегда Пример: |
|
physical_disk complex |
Подробная информация о свойствах физического диска для данного диска. Возвращается: если существует |
|
allocated_size integer |
Выделенный размер данного физического диска в байтах. Возвращается: всегда Пример: |
|
bus_type string |
Тип шины данного физического диска. Возвращается: всегда Пример: |
|
can_pool boolean |
Сведения о том, можно ли добавить данный физический диск в пул хранения. Возвращается: всегда Пример: |
|
cannot_pool_reason string |
Причина, по которой данный физический диск нельзя добавить в пул хранения. Возвращается: если свойство can_pool имеет значение false Пример: |
|
device_id string |
Идентификатор конкретного физического диска. Возвращается: всегда Пример: |
|
friendly_name string |
Понятное имя конкретного физического диска. Возвращается: всегда Пример: |
|
health_status string |
Состояние конкретного физического диска. Возвращается: всегда Пример: |
|
indication_enabled boolean |
Сведения о том, включена ли индикация для конкретного физического диска. Возвращается: всегда Пример: |
|
manufacturer string |
Производитель конкретного физического диска. Возвращается: всегда Пример: |
|
media_type string |
Тип носителя конкретного физического диска. Возвращается: всегда Пример: |
|
model string |
Модель конкретного физического диска. Возвращается: всегда Пример: |
|
object_id string |
Идентификатор объекта конкретного физического диска. Возвращается: всегда Пример: |
|
operational_status string |
Рабочее состояние конкретного физического диска. Возвращается: всегда Пример: |
|
partial boolean |
Сведения о том, является ли конкретный физический диск частичным. Возвращается: всегда Пример: |
|
physical_location string |
Физическое расположение конкретного физического диска. Возвращается: всегда Пример: |
|
serial_number string |
Серийный номер конкретного физического диска. Возвращается: всегда Пример: |
|
size integer |
Размер конкретного физического диска в байтах. Возвращается: всегда Пример: |
|
spindle_speed integer |
Скорость вращения шпинделя конкретного физического диска в об/мин. Возвращается: всегда Пример: |
|
supported_usages complex |
Поддерживаемые типы использования конкретного физического диска. Возвращается: всегда |
|
Count integer |
Количество поддерживаемых типов использования. Возвращается: всегда Пример: |
|
value string |
Список поддерживаемых типов использования. Возвращается: всегда Пример: |
|
unique_id string |
Уникальный идентификатор конкретного физического диска. Возвращается: всегда Пример: |
|
usage_type string |
Тип использования конкретного физического диска. Возвращается: всегда Пример: |
|
read_only boolean |
Состояние режима только для чтения конкретного диска. Возвращается: всегда Пример: |
|
sector_size integer |
Размер сектора конкретного диска в байтах. Возвращается: всегда Пример: |
|
serial_number string |
Серийный номер конкретного диска на целевом узле. Возвращается: всегда Пример: |
|
size integer |
Размер конкретного диска в байтах. Возвращается: всегда Пример: |
|
system_disk boolean |
Сведения о том, является ли конкретный диск системным. Возвращается: всегда Пример: |
|
unique_id string |
Уникальный идентификатор конкретного диска на целевом узле. Возвращается: всегда Пример: |
|
virtual_disk complex |
Подробные сведения о свойствах виртуального диска для конкретного диска. Возвращается: если существует |
|
access string |
Режим доступа к конкретному виртуальному диску. Возвращается: всегда Пример: |
|
allocated_size integer |
Выделенный размер конкретного виртуального диска в байтах. Возвращается: всегда Пример: |
|
allocation_unit_size integer |
Размер единицы выделения конкретного виртуального диска в байтах. Возвращается: всегда Пример: |
|
available_copies integer |
Количество доступных копий конкретного виртуального диска. Возвращается: если существует Пример: |
|
columns integer |
Количество столбцов конкретного виртуального диска. Возвращается: всегда Пример: |
|
deduplication_enabled boolean |
Сведения о том, включена ли дедупликация для конкретного виртуального диска. Возвращается: всегда Пример: |
|
detached_reason string |
Причина отсоединения конкретного виртуального диска. Возвращается: всегда Пример: |
|
enclosure_aware boolean |
Сведения о том, поддерживает ли конкретный виртуальный диск распознавание корпуса. Возвращается: всегда Пример: |
|
fault_domain_awareness string |
Уровень учета доменов отказа для конкретного виртуального диска. Возвращается: всегда Пример: |
|
footprint_on_pool integer |
Объем, занимаемый конкретным виртуальным диском в пуле, в байтах. Возвращается: всегда Пример: |
|
friendly_name string |
Понятное имя конкретного виртуального диска. Возвращается: всегда Пример: |
|
groups integer |
Количество групп конкретного виртуального диска. Возвращается: всегда Пример: |
|
health_status string |
Состояние конкретного виртуального диска. Возвращается: всегда Пример: |
|
inter_leave integer |
Размер чередования конкретного виртуального диска в байтах. Возвращается: всегда Пример: |
|
logical_sector_size integer |
Размер логического сектора конкретного виртуального диска в байтах. Возвращается: всегда Пример: |
|
manual_attach boolean |
Сведения о том, подключается ли конкретный виртуальный диск вручную. Возвращается: всегда Пример: |
|
media_type string |
Тип носителя конкретного виртуального диска. Возвращается: всегда Пример: |
|
name string |
Имя конкретного виртуального диска. Возвращается: всегда Пример: |
|
object_id string |
Идентификатор объекта конкретного виртуального диска. Возвращается: всегда Пример: |
|
operational_status string |
Рабочее состояние данного виртуального диска. Возвращается: всегда Пример: |
|
parity_layout integer |
Схема четности данного виртуального диска. Возвращается: если существует Пример: |
|
physical_disk_redundancy integer |
Тип избыточности физических дисков данного виртуального диска. Возвращается: всегда Пример: |
|
physical_sector_size integer |
Размер физического сектора данного виртуального диска в байтах. Возвращается: всегда Пример: |
|
provisioning_type string |
Тип выделения ресурсов для данного виртуального диска. Возвращается: всегда Пример: |
|
read_cache_size integer |
Размер кэша чтения данного виртуального диска в байтах. Возвращается: всегда Пример: |
|
request_no_spof boolean |
Указывает, запрашивает ли данный виртуальный диск отсутствие единой точки отказа. Возвращается: всегда Пример: |
|
resiliency_setting_name integer |
Тип избыточности физических дисков данного виртуального диска. Возвращается: всегда Пример: |
|
size integer |
Размер данного виртуального диска в байтах. Возвращается: всегда Пример: |
|
snapshot boolean |
Указывает, является ли данный виртуальный диск снимком. Возвращается: всегда Пример: |
|
tiered boolean |
Указывает, использует ли данный виртуальный диск уровневое хранение. Возвращается: всегда Пример: |
|
unique_id string |
Уникальный идентификатор данного виртуального диска. Возвращается: всегда Пример: |
|
unique_id_format string |
Формат уникального идентификатора данного виртуального диска. Возвращается: всегда Пример: |
|
write_cache_size integer |
Размер кэша записи данного виртуального диска в байтах. Возвращается: всегда Пример: |
|
win32_disk_drive complex |
Представление класса Win32_DiskDrive. Возвращается: если существует |
|
availability integer |
Доступность и состояние устройства. Возвращается: всегда |
|
bytes_per_sector integer |
Количество байтов в каждом секторе физического дисковода. Возвращается: всегда Пример: |
|
capabilities list / elements=string |
Массив возможностей устройства доступа к носителям. Например, устройство может поддерживать произвольный доступ (3), сменные носители (7) и автоматическую очистку (9). Возвращается: всегда Пример: |
|
capability_descriptions list / elements=string |
Список подробных описаний функций устройства доступа, указанных в массиве Capabilities. Обратите внимание: каждая запись этого массива соответствует записи в массиве Capabilities с тем же индексом. Возвращается: всегда Пример: |
|
caption string |
Краткое описание объекта. Возвращается: всегда Пример: |
|
compression_method string |
Алгоритм или средство, используемое устройством для поддержки сжатия. Возвращается: всегда Пример: |
|
config_manager_error_code integer |
Код ошибки диспетчера конфигурации Windows. Возвращается: всегда Пример: |
|
config_manager_user_config boolean |
Если значение True, устройство использует конфигурацию, заданную пользователем. Возвращается: всегда Пример: |
|
creation_class_name string |
Имя первого конкретного класса в цепочке наследования, используемого при создании экземпляра. При использовании вместе с другими ключевыми свойствами класса это свойство позволяет однозначно идентифицировать все экземпляры этого класса и его подклассов. Возвращается: всегда Пример: |
|
default_block_size integer |
Размер блока по умолчанию для этого устройства в байтах. Возвращается: всегда Пример: |
|
description string |
Описание объекта. Возвращается: всегда Пример: |
|
device_id string |
Уникальный идентификатор дисковода среди других устройств системы. Возвращается: всегда Пример: |
|
error_cleared boolean |
Если значение True, ошибка, указанная в LastErrorCode, устранена. Возвращается: всегда Пример: |
|
error_description string |
Дополнительные сведения об ошибке, зарегистрированной в LastErrorCode, а также информация о возможных способах ее устранения. Возвращается: всегда |
|
error_methodology string |
Тип обнаружения и исправления ошибок, поддерживаемый этим устройством. Возвращается: всегда |
|
firmware_revision string |
Версия прошивки дисковода, присвоенная производителем. Возвращается: всегда Пример: |
|
index integer |
Номер физического диска для указанного дисковода. Это свойство заполняется данными структуры STORAGE_DEVICE_NUMBER, возвращаемой управляющим кодом IOCTL_STORAGE_GET_DEVICE_NUMBER. Значение 0xffffffff указывает, что указанный дисковод не сопоставлен с физическим диском. Возвращается: всегда Пример: |
|
install_date string |
Дата и время установки объекта. Для обозначения того, что объект установлен, этому свойству не обязательно присваивать значение. Возвращается: всегда |
|
interface_type string |
Тип интерфейса физического дисковода. Возвращается: всегда Пример: |
|
last_error_code integer |
Последний код ошибки, сообщенный логическим устройством. Возвращается: всегда |
|
manufacturer string |
Название производителя дисковода. Возвращается: всегда Пример: |
|
max_block_size integer |
Максимальный размер блока в байтах для носителей, доступ к которым осуществляется с помощью этого устройства. Возвращается: всегда |
|
max_media_size integer |
Максимальный размер носителя в килобайтах, поддерживаемый этим устройством. Возвращается: всегда |
|
media_loaded boolean |
Если значение True, носитель в дисководе загружен: устройство имеет доступную для чтения файловую систему и доступно для использования. Для дисководов с фиксированным диском это свойство всегда имеет значение TRUE. Возвращается: всегда Пример: |
|
media_type string |
Тип носителя, используемого этим устройством или доступного через него. Возвращается: всегда Пример: |
|
min_block_size integer |
Минимальный размер блока в байтах для носителей, доступ к которым осуществляется с помощью этого устройства. Возвращается: всегда |
|
model string |
Номер модели дисковода, присвоенный производителем. Возвращается: всегда Пример: |
|
name string |
Метка, под которой известен объект. В подклассе это свойство можно переопределить и использовать как ключевое. Возвращается: всегда Пример: |
|
needs_cleaning boolean |
Если значение True, устройство доступа к носителям нуждается в очистке. Возможность ручной или автоматической очистки указана в свойстве Capabilities. Возвращается: всегда |
|
number_of_media_supported integer |
Максимальное количество носителей, которые могут поддерживаться или устанавливаться (если устройство доступа к носителям поддерживает несколько отдельных носителей). Возвращается: всегда |
|
partitions integer |
Количество разделов на этом физическом диске, распознаваемых операционной системой. Возвращается: всегда Пример: |
|
pnp_device_id string |
Идентификатор устройства Windows Plug and Play для логического устройства. Возвращается: всегда Пример: |
|
power_management_capabilities list / elements=string |
Массив характеристик логического устройства, связанных с управлением питанием. Возвращается: всегда |
|
power_management_supported boolean |
Если значение равно True, устройством можно управлять с точки зрения питания (например, переводить в режим ожидания). Это свойство не указывает, включены ли в данный момент функции управления питанием, а лишь означает, что логическое устройство поддерживает управление питанием. Возвращается: всегда |
|
scsi_bus integer |
Номер шины SCSI дискового накопителя. Возвращается: всегда Пример: |
|
scsi_logical_unit integer |
Номер логического устройства SCSI (LUN) дискового накопителя. Возвращается: всегда Пример: |
|
scsi_port integer |
Номер порта SCSI дискового накопителя. Возвращается: всегда Пример: |
|
scsi_target_id integer |
Идентификатор SCSI дискового накопителя. Возвращается: всегда Пример: |
|
sectors_per_track integer |
Количество секторов в каждой дорожке этого физического диска. Возвращается: всегда Пример: |
|
serial_number string |
Номер, присвоенный производителем для идентификации физического носителя. Возвращается: всегда Пример: |
|
signature integer |
Идентификатор диска. Это свойство можно использовать для идентификации общего ресурса. Возвращается: всегда |
|
size integer |
Размер дискового накопителя. Он вычисляется путем умножения общего количества цилиндров на количество дорожек в каждом цилиндре, секторов в каждой дорожке и байтов в каждом секторе. Возвращается: всегда Пример: |
|
status string |
Текущее состояние объекта. Можно определить различные рабочие и нерабочие состояния. К рабочим состояниям относятся: «OK», «Degraded» и «Pred Fail» (например, устройство, такое как жесткий диск с поддержкой SMART, может работать нормально, но предсказывать скорый отказ). К нерабочим состояниям относятся: «Error», «Starting», «Stopping» и «Service». Состояние «Service» может применяться во время повторной синхронизации зеркала диска, перезагрузки списка пользовательских разрешений или выполнения других административных задач. Не все такие задачи выполняются в оперативном режиме, однако управляемый элемент при этом не находится ни в состоянии «OK», ни в одном из других состояний. Возвращается: всегда Пример: |
|
status_info integer |
Состояние логического устройства. Если это свойство неприменимо к логическому устройству, следует использовать значение 5 (не применимо). Возвращается: всегда |
|
system_creation_class_name string |
Значение свойства CreationClassName компьютера, в область действия которого входит устройство. Возвращается: всегда Пример: |
|
system_name string |
Имя системы, в область действия которой входит устройство. Возвращается: всегда Пример: |
|
total_cylinders integer |
Общее количество цилиндров на физическом диске. Примечание: значение этого свойства получают с помощью расширенных функций прерывания BIOS 13h. Значение может быть неточным, если накопитель использует схему трансляции для поддержки дисков большой емкости. Для получения точных характеристик накопителя обратитесь к производителю. Возвращается: всегда Пример: |
|
total_heads integer |
Общее количество головок дискового накопителя. Примечание: значение этого свойства получают с помощью расширенных функций прерывания BIOS 13h. Значение может быть неточным, если накопитель использует схему трансляции для поддержки дисков большой емкости. Для получения точных характеристик накопителя обратитесь к производителю. Возвращается: всегда Пример: |
|
total_sectors integer |
Общее количество секторов на физическом диске. Примечание: значение этого свойства получают с помощью расширенных функций прерывания BIOS 13h. Значение может быть неточным, если накопитель использует схему трансляции для поддержки дисков большой емкости. Для получения точных характеристик накопителя обратитесь к производителю. Возвращается: всегда Пример: |
|
total_tracks integer |
Общее количество дорожек на физическом диске. Примечание: значение этого свойства получают с помощью расширенных функций прерывания BIOS 13h. Значение может быть неточным, если накопитель использует схему трансляции для поддержки дисков большой емкости. Для получения точных характеристик накопителя обратитесь к производителю. Возвращается: всегда Пример: |
|
tracks_per_cylinder integer |
Количество дорожек в каждом цилиндре физического диска. Примечание: значение этого свойства получают с помощью расширенных функций прерывания BIOS 13h. Значение может быть неточным, если накопитель использует схему трансляции для поддержки дисков большой емкости. Для получения точных характеристик накопителя обратитесь к производителю. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/windows/win_disk_facts_module.html