:py:mod:`pywebui.disks`
=======================

.. py:module:: pywebui.disks


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   pywebui.disks.Disk
   pywebui.disks.DiskMethods




.. py:class:: Disk



   Storage object.

   .. attribute:: alloClass

      the allocation class of the host.

      :type: int

   .. attribute:: availablePathCount

      the number of available, working paths for a multipath-capable device.

      :type: int

   .. attribute:: clusterSize

      the volume cluster size.

      :type: int

   .. attribute:: defBufSize

      the default buffer size.

      :type: int

   .. attribute:: devChars

      device-independent characteristics object.

      :type: dict

   .. attribute:: devDescription

      the description of device options.

      :type: str

   .. attribute:: deviceName

      the disk name.

      :type: str

   .. attribute:: devProt

      the protection data of the device.

      :type: str

   .. attribute:: displayDevName

      extended disk name.

      :type: str

   .. attribute:: errСnt

      the error count of the disk.

      :type: int

   .. attribute:: expSizeLimit

      the current expansion limit on the volume object, which contains two fields:
      blocks - the current expansion limit on the volume in blocks (one block is 512 bytes).
      bytes - the current expansion limit on the volume in bytes.

      :type: list(str)

   .. attribute:: extendQuantity

      the default extension size for all files on the volume.

      :type: int

   .. attribute:: fastPath

      is unit supports FAST PATH Affinity.

      :type: int

   .. attribute:: freeSpace

      the free space object, which contains two fields:
      blocks - the number of free blocks on a disk (one block is 512 bytes).
      bytes - the number of free bytes on a disk.

      :type: list(str)

   .. attribute:: hostName

      the name of the host serving the primary path.

      :type: str

   .. attribute:: logVolSize

      the current logical volume size of the volume object, which contains two fields:
      blocks - the current logical volume size in blocks (one block is 512 bytes).
      bytes - the current logical volume size in bytes.

      :type: list(str)

   .. attribute:: maxFilesAllowed

      the maximum number of files on the volume.

      :type: int

   .. attribute:: mountСnt

      the number of times the volume has been mounted on the local system.

      :type: int

   .. attribute:: mountStatus

      the mount status of the volume.

      :type: str

   .. attribute:: opCnt

      the operation count of the disk.

      :type: int

   .. attribute:: ownerPID

      the process identification (PID) of the owner of the device.

      :type: str

   .. attribute:: ownerProcess

      the owner of the disk.

      :type: str

   .. attribute:: ownerUIC

      the user identification code (UIC) of the owner of the device as a string.

      :type: str

   .. attribute:: prefCPU

      the preferred CPU.

      :type: int

   .. attribute:: refCnt

      the number of channels assigned to the disk.

      :type: int

   .. attribute:: relVolNumber

      the volume number of this volume in the volume set.

      :type: int

   .. attribute:: secPerTrack

      the number of sectors per track.

      :type: int

   .. attribute:: totalCyls

      the number of cylinders on the volume.

      :type: int

   .. attribute:: totalSize

      the maximum size on the volume object, which contains two fields:
      blocks - the maximum size on the volume in blocks (one block is 512 bytes).
      bytes - the maximum size on the volume in bytes.

      :type: list(str)

   .. attribute:: transСnt

      the transaction count for the volume.

      :type: int

   .. attribute:: trPerCyl

      the number of tracks per cylinder.

      :type: int

   .. attribute:: volDescription

      the description of volume options.

      :type: str

   .. attribute:: volName

      the volume name.

      :type: str

   .. attribute:: volOwnerUIC

      the user identification code (UIC) of the owner of the volume as a string

      :type: str

   .. attribute:: volProt

      the protection data of the volume.

      :type: str

   .. attribute:: wwid

      the World Wide Identifier (WWID) of the disk.

      :type: str


.. py:class:: DiskMethods

   Encapsulates methods for manage storage.

   .. py:method:: get_disks(self) -> List[Disk]

      Returns the list of all disks.


   .. py:method:: get_disk(self, device) -> Disk

      Returns details for selected disk.