SCSI Objects¶

SCSI Device¶

class SCSIDevice¶

asi_context()¶: Returns a context for infi.asi

get_connectivity()¶: Returns a infi.storagemodel.connectivity.FCConnectivity instance.

get_display_name()¶: Returns a friendly device name. In Windows, it’s PHYSICALDRIVE%d, in linux, its sdX.

get_hctl()¶: Returns a infi.dtypes.hctl.HCTL object

get_scsi_access_path()¶

Returns a string path for the device

In Windows, it’s something under globalroot like block_device_path
In linux, it’s /dev/sgX

get_scsi_ata_information()¶: Returns the SCSI ata information of the device as a dict of dicts for SATL and identify device

get_scsi_inquiry_pages()¶

Returns an immutable dict-like object of available inquiry pages from this device. For example:

>>> device.get_scsi_inquiry_pages()[0x80].product_serial_number

get_scsi_product_id()¶: Returns the stripped T10 product identifier string, as give in SCSI Standard Inquiry

get_scsi_revision()¶: Returns the stripped T10 revision string, as give in SCSI Standard Inquiry

get_scsi_serial_number()¶: Returns the SCSI serial string of the device or an empty string (“”) if not available

get_scsi_standard_inquiry()¶: Returns the standard inquiry data

get_scsi_test_unit_ready()¶: Returns True if the device is ready, False if got NOT_READY check condition

get_scsi_vendor_id()¶: Returns the stripped T10 vendor identifier string, as give in SCSI Standard Inquiry

get_scsi_vendor_id_or_unknown_on_error()¶: Returns (‘<unknown>’, ‘<unknown>’) on unexpected error instead of raising exception

get_scsi_vid_pid()¶: Returns a tuple of the vendor_id and product_id

get_scsi_vid_pid_rev()¶: Returns a tuple of the vendor_id, product_id and revision

SCSI Block Device¶

class SCSIBlockDevice¶: Bases: infi.storagemodel.base.scsi.SCSIDevice

SCSI Storage Controller Device¶

class SCSIStorageController¶: Bases: infi.storagemodel.base.scsi.SCSIDevice

Multipath Objects¶

Multipath Device¶

class MultipathBlockDevice¶

asi_context()¶: Returns an infi.asi context

get_block_access_path()¶: Returns a path for the device

get_disk_drive()¶

Returns a infi.storagemodel.base.disk.DiskDrive instance.

Raises infi.storagemodel.base.disk.NoSuchDisk if not found.

get_display_name()¶: Returns a string represtation for the device

get_paths()¶: Returns a list of infi.storagemodel.base.multipath.Path instances

get_policy()¶: Returns an instance of infi.storagemodel.base.multipath.LoadBalancePolicy

get_scsi_ata_information()¶: Returns the SCSI ata information of the device as a dict of dicts for SATL and identify device

get_scsi_inquiry_pages()¶

Returns an immutable dict-like object of available inquiry pages from this device. For example:

>>> device.get_scsi_inquiry_pages()[0x80].product_serial_number

get_scsi_product_id()¶: Returns the stripped T10 product identifier string, as give in SCSI Standard Inquiry

get_scsi_revision()¶: Returns the stripped T10 revision string, as give in SCSI Standard Inquiry

get_scsi_serial_number()¶: Returns the SCSI serial string of the device or an empty string (“”) if not available

get_scsi_standard_inquiry()¶: Returns the standard inquiry data

get_scsi_test_unit_ready()¶: Returns True if the device is ready, False if got NOT_READY check condition

get_scsi_vendor_id()¶: Returns the stripped T10 vendor identifier string, as give in SCSI Standard Inquiry

get_scsi_vendor_id_or_unknown_on_error()¶: Returns (‘<unknown>’, ‘<unknown>’) on unexpected error instead of raising exception

get_scsi_vid_pid()¶: Returns a tuple of the vendor_id and product_id

get_scsi_vid_pid_rev()¶: Returns a tuple of the vendor_id, product_id and revision

get_vendor()¶: Returns a get_vendor-specific implementation from the factory based on the device’s SCSI vid and pid

Multipath Path¶

class Path¶

get_alua_state()¶: Returns the ALUA (Asymmetric Logical Unit Access) value

get_connectivity()¶: Returns an infi.storagemodel.connectivity.FCConnectivity instance.

get_display_name()¶: Returns the path name (currently the same as get_path_id).

get_hctl()¶: Returns a infi.dtypes.hctl.HCTL instance

get_io_statistics()¶: Returns a infi.storagemodel.base.multipath.PathStatistics instance

get_path_id()¶

Returns depending on the operating system:

sdX on linux
PathId on Windows

get_state()¶: Returns either “up” or “down”.

Load Balance Policies¶

class LoadBalancePolicy¶: Base class of all available load balancing policies

class FailoverOnly(active_path_id)¶

Bases: infi.storagemodel.base.multipath.LoadBalancePolicy

Load balancing policy where the alternative paths are used only in case the active path fails.

class RoundRobin¶

Bases: infi.storagemodel.base.multipath.LoadBalancePolicy

Load balancing policy where all paths are used in a balanced way.

class RoundRobinWithSubset(active_path_ids)¶

Bases: infi.storagemodel.base.multipath.LoadBalancePolicy

Load balancing policy where a subset of the paths are used in a balanced way.

class RoundRobinWithTPGSSubset(active_path_ids)¶

Bases: infi.storagemodel.base.multipath.RoundRobinWithSubset

Load balancing policy where only paths that are active/optimized according to TPGS are used

class RoundRobinWithExplicitSubset(active_path_ids)¶

Bases: infi.storagemodel.base.multipath.RoundRobinWithSubset

Load balancing policy where an explicitly-given subset of the paths are used

class WeightedPaths(weights)¶

Bases: infi.storagemodel.base.multipath.LoadBalancePolicy

Load balancing policy that assigns a weight to each path. The weight indicates the relative priority of a given path. The larger the number, the lower ranked the priority.

class LeastBlocks¶

Bases: infi.storagemodel.base.multipath.LoadBalancePolicy

Load balancing policy that sends I/O down the path with the least number of data blocks currently being processed

class LeastQueueDepth¶

Bases: infi.storagemodel.base.multipath.LoadBalancePolicy

Load balancing policy that sends I/O down the path with the fewest currently outstanding I/O requests.

Disk Objects¶

Disk Drive¶

class DiskDrive¶

create_guid_partition_table(alignment_in_bytes=None)¶: Creates a GUID partition table and returns it (infi.storagemodel.base.partition.GUIDPartitionTable)

create_mbr_partition_table(alignment_in_bytes=None)¶: Creates an MBR partition table and returns it (infi.storagemodel.base.partition.MBRPartitionTable)

delete_partition_table()¶: Deletes the partition table from the disk

get_block_access_path()¶: Returns the block access path for the disk

get_partition_table()¶: Returns the disk’s partition table (infi.storagemodel.base.partition.PartitionTable). Raises ValueError if there is no partition table on disk.

get_size_in_bytes()¶: Returns the disk size in bytes

get_storage_device()¶: Returns the storage device that is represented by this disk drive - either a infi.storagemodel.base.multipath.MultipathDevice or infi.storagemodel.base.scsi.SCSIBlockDevice

is_empty()¶: Returns True if the disk has no partition table.

Partition Objects¶

Partition Table¶

class PartitionTable¶

Base class for representing patition tables

create_partition_for_whole_table(file_system_object, alignment_in_bytes=None)¶

Creates a partition that fills the entire drive. The partition is set to use the given filesystem, but does not get formatted by this method.

Changes are written immediately on disk. The partition table is re-read and the cache for the current object is cleared.

Returns a infi.storagemodel.base.partition.Partition object

classmethod create_partition_table(disk_drive, alignment_in_bytes=None)¶

Creates a partition table of the requested class on the given infi.storagemodel.base.disk.DiskDrive. No partitions are created inside the partition table.

Changes are written immediately on disk. The partition table is re-read and the cache for the current object is cleared.

Returns The newly created infi.storagemodel.base.partition.Partition object

get_disk_drive()¶: Returns the infi.storagemodel.base.disk.DiskDrive that holds the partition

get_partitions()¶: Returns a list of infi.storagemodel.base.partition.Partition objects inside the partition table

is_empty()¶: Returns True if there are no partitions in the partition table

Master Boot Record¶

class MBRPartitionTable¶

Represents a Master Boot Record partition table

create_partition_for_whole_table(file_system_object, alignment_in_bytes=None)¶

Creates a partition that fills the entire drive. The partition is set to use the given filesystem, but does not get formatted by this method.

Changes are written immediately on disk. The partition table is re-read and the cache for the current object is cleared.

Returns a infi.storagemodel.base.partition.Partition object

classmethod create_partition_table(disk_drive, alignment_in_bytes=None)¶

Creates a partition table of the requested class on the given infi.storagemodel.base.disk.DiskDrive. No partitions are created inside the partition table.

Changes are written immediately on disk. The partition table is re-read and the cache for the current object is cleared.

Returns The newly created infi.storagemodel.base.partition.Partition object

get_disk_drive()¶: Returns the infi.storagemodel.base.disk.DiskDrive that holds the partition

get_partitions()¶: Returns a list of infi.storagemodel.base.partition.Partition objects inside the partition table

is_empty()¶: Returns True if there are no partitions in the partition table

Mount Objects¶

Mount¶

class Mount¶

Represents a non-persistent mount in the operating system

get_block_access_path()¶: Returns the block access path of the device to be mounted

get_filesystem()¶: Returns the infi.storagemodel.base.filesystem.FileSystem object that requested to be mounted

get_mount_options()¶: Returns filesystem-specific mount options

get_mount_point()¶: Returns the mount point

Persistent Mount¶

class PersistentMount¶

Represents a persistent mount in the operating system

get_block_access_path()¶: Returns the block access path of the device to be mounted

get_filesystem()¶: Returns the infi.storagemodel.base.filesystem.FileSystem object that requested to be mounted

get_mount_options()¶: Returns filesystem-specific mount options

get_mount_point()¶: Returns the mount point

File System Objects¶

Filesystem¶

class FileSystem¶

Represents a Filesystem that can be formatted and mounted

format(block_device, *args, **kwargs)¶

Formats the device with this filesystem.

block_device: either a infi.storagemodel.base.scsi.SCSIBlockDevice,: infi.storagemodel.base.multipath.MultipathDevice or infi.storagemodel.base.partition.Partition

Raises infi.storagemodel.errors.StorageModelError if the format has failed

get_label(block_access_path)¶

Returns the block device label, or an empty string if there’s no label.

Raises infi.storagemodel.errors.LabelNotSupported if operation not supported by the filesystem

get_name()¶: Returns the string name of the filesystem

mount(block_access_path, mount_point, mount_options_dict={})¶

Mounts a device to the mount point, with the given options dictionary.

block_device_path: the block access path of the storage device

mount_point: the path to the mount point

mount_options_dict: filesystem-specific mount options

Raises infi.storagemodel.errors.MountPointDoesNotExist if the mount point does not exist

Raises infi.storagemodel.errors.MountPointInUse if the mount point is in use by another mount

Raises infi.storagemodel.errors.AlreadyMounted if the device is already mounted

Returns a infi.storagemodel.mount.Mount object

resize(size_in_bytes)¶: Resize a filesystem. On platforms where resizing isn’t neccessary, this method does nothing (e.g. Windows)

set_label(block_access_path, label)¶

Sets a filesystem label on the specific block device.

Raises infi.storagemodel.errors.InvalidLabel if the label is too long

Raises infi.storagemodel.errors.LabelNotSupported if not supported by the filesystem

unmount(block_access_path, mount_point)¶

Unmount the filesystem from the mount point.

mount_point: path to the mount point

Raises infi.storagemodel.errors.NotMounted if the mount point argument is not a mounted path

Connectivity¶

Fiber Channel¶

Vendor Information¶

Infinidat¶

class InfiniBoxInquiryMixin¶

class InfiniBoxVolumeMixin¶

class SophisticatedMixin¶

class InfinidatNAA(data)¶

class InfinidatFiberChannelPort(relative_target_port_identifer, target_port_group)¶