APIs in Category: lun | Cluster-Mode API version 1.20

lun-alignment-get-iter lun-get-iter lun-get-vdisk-attributes lun-initiator-list-map-info lun-map-get-iter lun-stats-get-iter

NetApp Manage ONTAP

lun-alignment-get-iter | [top]

> Iterate over a list of lun objects.

> Input Name | Range | Type | Description
> desired-attributes |  | lun-align-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | lun-align-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the lun object. All lun objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | lun-align-info[] optional | The list of attributes of lun objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more lun objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

lun-get-iter | [top]

> Iterate over a list of lun objects.

> Input Name | Range | Type | Description
> desired-attributes |  | lun-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | lun-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the lun object. All lun objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | lun-info[] optional | The list of attributes of lun objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more lun objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

lun-get-vdisk-attributes | [top]

> Lookup a LUN path and storage system by serial number.

> Input Name | Range | Type | Description
> serial-number |  | string | Serial number for the LUN.
> Output Name | Range | Type | Description
> filer-name |  | string | In Data ONTAP 7-Mode, this is the name of the storage system or vfiler containing the LUN. In Data ONTAP Cluster-Mode, this is the name of the Vserver containing the LUN.
> path |  | string | Path for the specified LUN, for example: "/vol/vol0/lun1".

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> ENOENT |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVOLUMEBUSY |  |

lun-initiator-list-map-info | [top]

> List all the luns mapped to an initiator

> Input Name | Range | Type | Description
> initiator |  | string | initiator to check
> Output Name | Range | Type | Description
> lun-maps |  | lun-map-info[] optional | List of lun maps for the given initiator.

> Errno | Description
> EINVAL |  |
> EAPIERROR |  |

lun-map-get-iter | [top]

> Iterate over a list of LUN map detail objects.

> Input Name | Range | Type | Description
> desired-attributes |  | lun-map-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | lun-map-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the LUN map detail object. All LUN map detail objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | lun-map-info[] optional | The list of attributes of LUN map detail objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more LUN map detail objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

lun-stats-get-iter | [top]

> Iterate over a list of lun objects.

> Input Name | Range | Type | Description
> desired-attributes |  | lun-stats-info optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | lun-stats-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the lun object. All lun objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | lun-stats-info[] optional | The list of attributes of lun objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more lun objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

Element definition: lun-align-info | [top]

> LUN alignment Info of a LUN When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> alignment |  | alignment-state optional | Alignment of the LUN. Possible values: aligned, misaligned, partial-writes, indeterminate. Attributes: non-creatable, non-modifiable Possible values: "aligned" - All or most of the IO to the LUN is aligned to the underlying file, "misaligned" - A significant amount of IO to the LUN is not aligned to the underlying file, "partial_writes" - A significant amount of IO to the LUN is partial, "indeterminate" - There is not enough IO to determine the LUN's alignment state
> multiprotocol-type |  | string optional | The ostype for the LUN. Caller should specify a non-default ostype Attributes: non-creatable, non-modifiable
> partition-count | [0..2^32-1] | integer optional | Number of partitions on the LUN. Attributes: non-creatable, non-modifiable
> partition-scheme |  | partition-scheme optional | Partition scheme on the LUN. Possible values: mbr and gpt Attributes: non-creatable, non-modifiable Possible values: "mbr" - Master Boot Record Partition Table Scheme., "gpt" - GUID Partition Table Scheme., "unknown" - Partition Scheme other than MBR or GPT or an unformatted LUN.
> partition-table |  | partition-list-entry[] optional | Partition entries on the LUN.
> path |  | string optional | Path of the LUN Attributes: key, non-creatable, non-modifiable
> read-alignment-histogram |  | read-histogram-entry[] optional | Histogram of read operations of size 4k in percentage value.
> read-partial-blocks | [0..2^32-1] | integer optional | Total number of read operations of non 4k size in percentage value. Attributes: non-creatable, non-modifiable
> vserver |  | string optional | Vserver hosting the LUN Attributes: key, non-creatable, non-modifiable
> write-alignment-histogram |  | write-histogram-entry[] optional | Histogram of write operations of size 4k in percentage value.
> write-partial-blocks | [0..2^32-1] | integer optional | Total number of write operations of non 4k size in percentage value. Attributes: non-creatable, non-modifiable

Element definition: lun-info | [top]

> Information of a LUN.

> Name | Range | Type | Description
> alignment |  | string optional | Alignment of the LUN. Possible values: "aligned", "misaligned", "partial_writes" or "indeterminate".
> backing-snapshot |  | string optional | Path to the backing snapshot file for a LUN, if there is one. Only returned if it has one. Note: This element is not returned for LUNs which are in snapshots.
> block-size | [0..2^31-1] | integer optional | Disk block size of the LUN in bytes. This field is unavailable while the LUN is fenced for a restore operation.
> class |  | string optional | The class of the LUN. Possible values: "regular" - The LUN is intended for normal blocks access, "protocol_endpoint" - The LUN is a VMware vvol protocol endpoint, "vvol" - The LUN is a VMware vvol data LUN.
> clone-backing-snapshot |  | string optional |
> comment |  | string optional | User-specified comment for the LUN. This field is unavailable when the LUN is in a snapshot or while the LUN fenced for a restore operation.
> creation-timestamp | [0..2^31-1] | integer optional | The time this LUN was created, in seconds since January 1, 1970. This field is unavailable when the LUN is in a snapshot or while the LUN fenced for a restore operation.
> device-binary-id |  | string optional | SCSI Peripheral Device Identifying Information returned in response to the SCSI command REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b). Value is encoded as a hexadecimal string, representing 1 to 64 bytes. Only present if a Peripheral Device Idendentifying Information value has been set on the LUN.
> device-id | [1..9999] | integer optional | SCSI Peripheral Device Identifying Information returned in response to the vendor unique SCSI command GET DEV ID. Only present if a Peripheral Device Identifying Information value appropriate for GET DEV ID has been set on the LUN.
> device-text-id |  | string optional | SCSI Peripheral Device Text Identifying Information returned in response to the SCSI command REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b). Value is a free-form UTF-8 string between 1 and 255 bytes in length. Only present if a Peripheral Device Text Identifying Information value has been set on the LUN.
> is-clone |  | boolean optional | "true" if the lun is a clone "false" otherwise.
> is-clone-autodelete-enabled |  | boolean optional | "true" if the lun clone is allowed to be deleted by autodelete in try/disrupt mode. autodelete will be allowed to delete the lun clone in try/disrupt mode if configured. "false" otherwise. The lun clone will not be deleted by autodelete in try/disrupt mode if configured.
> is-restore-inaccessible |  | boolean optional | If true, the LUN is fenced for I/O and management operations due to an ongoing restore operation. If false, the LUN is available for normal operations.
> is-space-alloc-enabled |  | boolean optional | Whether or not the LUN has space allocation enabled. This field is unavailable when the LUN is in a snapshot or while fenced for a restore operation.
> is-space-reservation-enabled |  | boolean optional | Whether or not the LUN has space reservation enabled. This field is unavailable when the LUN is in a snapshot or while fenced for a restore operation
> mapped |  | boolean optional | Whether or not the LUN is mapped to any initiators. "true" if mapped, "false" otherwise. This field is not applicable to LUNs where the class attribute is set to 'vvol'.
> multiprotocol-type |  | lun-os-type optional | OS type of the LUN This field is unavailable while the LUN is fenced for a restore operation.
> online |  | boolean | State of the LUN, ("online" or "offline"). "true" if online, "false" otherwise.
> path |  | string | Path of the LUN.
> prefix-size | [0..2^63-1] | integer optional | Size of the prefix stream for this LUN in bytes. This is either the default value for the OS type of the LUN or value specified in lun-create-by-size API. This field is unavailable while the LUN is fenced for a restore operation. This field is available in Data ONTAP 8.1 and later.
> qos-policy-group |  | string optional | QoS policy group defines measurable Service Level Objectives (SLOs) that apply to the storage objects with which the policy group is associated. This field is only present if the LUN is assigned to a QoS policy This field is available in Data ONTAP 8.2 and later.
> qtree |  | string | Name of the qtree containing the LUN.
> read-only |  | boolean optional | "true" if the LUN is read only, "false" if read/write. This field is unavailable while the LUN is fenced for a restore operation.
> serial-number |  | string optional | Serial number of the LUN. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ . This field is unavailable when the LUN is in a snapshot.
> share-state |  | string | Share state of the LUN. Possible values: "all", "none", read", "unkown", "write". In the very rare case that the share state can not be determined, "unknown" is returned.
> size | [0..2^63-1] | integer optional | Size of this LUN in bytes in the active FS. This field is unavailable while the LUN is fenced for a restore operation.
> size-used | [0..2^63-1] | integer optional | Number of bytes used by this LUN. This field is unavailable while the LUN is fenced for a restore operation.
> staging |  | boolean | "true" if the LUN is a temporary staging LUN, "false" otherwise.
> suffix-size | [0..2^63-1] | integer optional | Size of the suffix stream for this LUN in bytes. This value is determined by the OS type of the LUN at creation time. This field is unavailable while the LUN is fenced for a restore operation. This field is available in Data ONTAP 8.1 and later.
> uuid |  | string optional | Universal unique identifier (UUID) for the LUN. This field is unavailable when the LUN is in a snapshot.
> volume |  | string | Name of the volume containing the LUN.
> vserver |  | string optional | Vserver containing the LUN.

Element definition: lun-map-info | [top]

> Information about a lun mapping

> Name | Range | Type | Description
> initiator-group |  | string | Initiator group used to map the lun to the requested initiator.
> initiator-group-uuid |  | string | The Universally-unique identifier (UUID) of the initiator group.
> lun-id | [0..4095] | integer | Logical Unit Number which the lun is mapped to for the requested initiator.
> lun-uuid |  | string | The Universally-unique identifier (UUID) of the LUN.
> path |  | string | Path of the LUN which is mapped to the requested initiator.
> vserver |  | string optional | Vserver containing the initiator group

Element definition: lun-stats-info | [top]

> Stats for a LUN.

> Name | Range | Type | Description
> block-size |  | integer optional | Disk block size for this LUN in bytes. This attribute is unavailable when the LUN is fenced for a restore operation.
> other-ops | [0..2^64-1] | integer | Total number of other SCSI ops executed.
> path |  | string | path of the LUN. (for example, "/vol/vol0/lun1")
> read-blocks | [0..2^64-1] | integer optional | Number of disk blocks read. This attribute is unavailable when the LUN is fenced for a restore operation.
> read-ops | [0..2^64-1] | integer | Total number of SCSI read ops executed.
> scsi-errors | [0..2^64-1] | integer | Total number of SCSI errors.
> vserver |  | string optional | Vserver containing the lun
> write-blocks | [0..2^64-1] | integer optional | Number of disk blocks written. This attribute is unavailable when the LUN is fenced for a restore operation.
> write-ops | [0..2^64-1] | integer | Total number of SCSI write ops executed.

Element definition: alignment-state | [top]

> aligned|misaligned|partial-writes|indeterminate Possible values: "aligned" - All or most of the IO to the LUN is aligned to the underlying file, "misaligned" - A significant amount of IO to the LUN is not aligned to the underlying file, "partial_writes" - A significant amount of IO to the LUN is partial, "indeterminate" - There is not enough IO to determine the LUN's alignment state

> [none]

Element definition: lun-os-type | [top]

> The image type of the lun. This value determines the proper alignment settings for the desired host filesystem layout. Possible values: "aix" The LUN will be used to store an AIX filesystem, "hpux" The LUN will be used to store an HP-UX filesystem, "hyper_v" The LUN will be used to store Hyper-V VHDs (Virtual Hard Disks), "image" The default type indicating no assumptions will be made about the data stored in the LUN, "linux" The LUN will be used to store a Linux filesystem with no partition table, "netware" The LUN will be used to store a Netware filesystem, "openvms" The LUN will be used to store an OpenVMS filesystem, "solaris" The LUN will be used to store a Solaris filesystem, in a single slice partition, "solaris_efi" The LUN will be used to store a Solaris filesystem with an EFI partition table, "vmware" The LUN will be used to store a VMware Virtual Machine File System (VMFS) containing Virtual Machine Disk Files (VMDKs), "windows" The LUN will be used to store a Windows filesystem with a Master Boot Record (MBR) partition table. "windows_2008" The LUN will be used to store a Windows filesystem with a Master Boot Record (MBR) partition table on Windows 2008 or later, "windows_gpt" The LUN will be used to store a Windows filesystem with a GUID Partition Table (GPT).

> [none]

Element definition: partition-list-entry | [top]

> Partition entries on the LUN.

> Name | Range | Type | Description
> partition-offset | [0..2^32-1] | integer optional | Partition start offset. Attributes: non-creatable, non-modifiable
> partition-type |  | string optional | Type of the partition in the partition table. Attributes: non-creatable, non-modifiable

Element definition: partition-scheme | [top]

> mbr|gpt|unknown Possible values: "mbr" - Master Boot Record Partition Table Scheme., "gpt" - GUID Partition Table Scheme., "unknown" - Partition Scheme other than MBR or GPT or an unformatted LUN.

> [none]

Element definition: read-histogram-entry | [top]

> Histogram of read operations of size 4k in percentage value.

> Name | Range | Type | Description
> bin-number | [0..2^32-1] | integer optional | Histogram bin number Attributes: non-creatable, non-modifiable
> bin-value | [0..2^32-1] | integer optional | Read histogram bin percentage value. Attributes: non-creatable, non-modifiable

Element definition: write-histogram-entry | [top]

> Histogram of write operations of size 4k in percentage value.

> Name | Range | Type | Description
> bin-number | [0..2^32-1] | integer optional | Histogram bin number Attributes: non-creatable, non-modifiable
> bin-value | [0..2^32-1] | integer optional | Write histogram bin percentage value. Attributes: non-creatable, non-modifiable