Files
deb-python-pyvmomi/docs/vim/host/ScsiDisk.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

29 lines
1.2 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _vim.host.ScsiLun: ../../vim/host/ScsiLun.rst
.. _UpdateDiskPartitions: ../../vim/host/StorageSystem.rst#updateDiskPartitions
.. _RetrieveDiskPartitionInfo: ../../vim/host/StorageSystem.rst#retrieveDiskPartitionInfo
.. _vim.host.DiskDimensions.Lba: ../../vim/host/DiskDimensions/Lba.rst
vim.host.ScsiDisk
=================
This data object type describes a SCSI disk. A SCSI disk contains a partition table which can be changed. To change a SCSI disk, use the device name and the partition specification.See `RetrieveDiskPartitionInfo`_ See `UpdateDiskPartitions`_
:extends: vim.host.ScsiLun_
Attributes:
capacity (`vim.host.DiskDimensions.Lba`_):
The size of SCSI disk using the Logical Block Addressing scheme.
devicePath (`str`_):
The device path of the ScsiDisk. This device path is a file path that can be opened to create partitions on the disk.See `RetrieveDiskPartitionInfo`_ See `UpdateDiskPartitions`_
ssd (`bool`_, optional):
Indicates whether the ScsiDisk is SSD backed. If unset, the information whether the ScsiDisk is SSD backed is unknown.