APIs in Category: lun | Vserver API version 1.15

lun-clear-persistent-reservation-info lun-create-by-size lun-create-from-file lun-destroy lun-get-attribute lun-get-comment lun-get-geometry lun-get-inquiry-info lun-get-iter lun-get-maxsize lun-get-minsize lun-get-occupied-size lun-get-persistent-reservation-info lun-get-select-attribute lun-get-serial-number lun-get-space-reservation-info lun-get-vdisk-attributes lun-has-scsi-reservations lun-initiator-list-map-info lun-initiator-logged-in lun-map lun-map-get-iter lun-map-list-info lun-move lun-offline lun-online lun-port-has-scsi-reservations lun-resize lun-set-attribute lun-set-comment lun-set-device-id lun-set-select-attribute lun-set-serial-number lun-set-space-alloc lun-set-space-reservation-info lun-stats-get-iter lun-unmap lun-unset-attribute lun-unset-device-id

NetApp Manage ONTAP

lun-clear-persistent-reservation-info | [top]

> Clear the SCSI-2 reservation or SCSI-3 persistent reservation information for a given LUN. Note: In Data ONTAP Cluster-Mode, the LUN must either be offline or not mapped to clear the persistent reservation information.

> Input Name | Range | Type | Description
> path |  | string | Path of the lun. The path should start with '/vol/'.

> Errno | Description
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVOLUMEBUSY |  |
> EVDISK_ERROR_VDISK_NOT_DISABLED |  |

> Vfiler-enabled
> Yes

lun-create-by-size | [top]

> Create a new lun of given size, with initially zero contents. The lun is created at the path given. No file should already exist at the given path. The directory specified in the path must be a qtree root directory. The size of the created lun could be larger than the size specified, in order to get an integral number of cylinders while reporting the geometry using SAN protocols.

> Input Name | Range | Type | Description
> ostype |  | lun-os-type optional | The os type for the LUN. The default type if not specified is "image". It is strongly recommended for the caller of this API to avoid using the "image" type because it could result in misconfigured LUNs. For example, a lun with ostype "image" could suffer major performance penalties when a Windows host is trying to access it.
> path |  | string | Path of the LUN.
> prefix-size | [0..2^63-1] | integer optional | The size of the prefix stream for this lun in bytes. Certain OS types store a small portion of the data corresponding to partition tables (or similar structures) in the prefix stream. This is part of the lun data and is transparent to hosts that access the LUN via block protocols. The default size is based on the ostype. Giving a value here overrides the default, but, it is strongly recommended to avoid changing this default size. The value in this field must be a multiple of 512 bytes. Note that this value has no effect when the lun-os-type is "image". This option is available in Data ONTAP 8.1 and later.
> size | [0..2^63-1] | integer | New size for the LUN in bytes.
> space-reservation-enabled |  | boolean optional | By default, the lun is space-reserved. If it is desired to manage space usage manually instead, this can be set to "false" which will create a LUN without any space being reserved.
> Output Name | Range | Type | Description
> actual-size | [0..2^63-1] | integer | The actual size of the LUN that was created, in bytes.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EOFFLINE |  |
> EISDIR |  |
> EONTAPI_EEXIST |  |
> ENAMETOOLONG |  |
> EONTAPI_ENOENT |  |
> EFTYPE |  |
> EONTAPI_EINVAL |  |
> EONTAPI_ENOSPC |  |
> EVDISK_ERROR_NOT_QTREE_ROOT |  |
> EVDISK_ERROR_NO_SUCH_VOLUME |  |
> EVDISK_ERROR_NO_SUCH_DIRECTORY |  |
> EVDISK_ERROR_SOURCE_IS_VDISK |  |
> EVDISK_ERROR_FILE_IS_SPC_RESERVED |  |
> EVDISK_ERROR_INVALID_SNAPSHOT_PATH |  |
> EVDISK_ERROR_NOT_IN_SAME_VOLUME |  |
> EVDISK_ERROR_SIZE_TOO_SMALL |  |
> EVDISK_ERROR_SIZE_TOO_LARGE |  |
> EVDISK_ERROR_VOLUME_SPARSE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-create-from-file | [top]

> Create a lun from an existing file. A new lun is created, at the given lun path (which must be at a qtree root). A hard link is created to the existing file. The file contents are not copied or changed. The file can be resized to a larger size, rounding up to a cylinder boundary.

> Input Name | Range | Type | Description
> file-name |  | string | A fully qualified filer path to the file to create the LUN from. This must be in the same qtree as the LUN being created.
> ostype |  | lun-os-type optional | The os type for the LUN. The default type if not specified is "image". It is strongly recommended for the caller of this API to avoid using the "image" type because it could result in misconfigured LUNs. For example, a lun with ostype "image" could suffer major performance penalties when a Windows host is trying to access it.
> path |  | string | Would be Path of the newly created LUN if successful. This Path must not exist already (i.e a file or dir with this same path).
> space-reservation-enabled |  | boolean optional | By default, the lun is space-reserved. If it is desired to manage space usage manually instead, this can be set to "false" which will create a LUN without any space being reserved.
> Output Name | Range | Type | Description
> actual-size | [0..2^63-1] | integer | The actual size of the LUN that was created, in bytes.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EOFFLINE |  |
> EISDIR |  |
> EONTAPI_EEXIST |  |
> ENAMETOOLONG |  |
> EONTAPI_ENOENT |  |
> EFTYPE |  |
> EONTAPI_EINVAL |  |
> EONTAPI_ENOSPC |  |
> EVDISK_ERROR_NOT_QTREE_ROOT |  |
> EVDISK_ERROR_NO_SUCH_VOLUME |  |
> EVDISK_ERROR_NO_SUCH_DIRECTORY |  |
> EVDISK_ERROR_SOURCE_IS_VDISK |  |
> EVDISK_ERROR_FILE_IS_SPC_RESERVED |  |
> EVDISK_ERROR_INVALID_SNAPSHOT_PATH |  |
> EVDISK_ERROR_NOT_IN_SAME_VOLUME |  |
> EVDISK_ERROR_SIZE_TOO_SMALL |  |
> EVDISK_ERROR_SIZE_TOO_LARGE |  |
> EVDISK_ERROR_VOLUME_SPARSE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-destroy | [top]

> Destroy the specified LUN. This operation will fail if the LUN is currently mapped and is online. The force option can be used to destroy it regardless of being online or mapped.

> Input Name | Range | Type | Description
> force |  | boolean optional | If "true", override checks that prevent a LUN from being destroyed if it is online and mapped. If "false", destroying an online and mapped LUN will fail. The default if not specified is "false".
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EONTAPI_ENOENT |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_VDISK_EXPORTED |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-get-attribute | [top]

> Get a named attribute for a given LUN.

> Input Name | Range | Type | Description
> name |  | string | Attribute to get.
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> value |  | string | Value of the attribute.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |
> EVDISK_ERROR_NO_SUCH_ATTRIBUTE |  |

> Vfiler-enabled
> Yes

lun-get-comment | [top]

> Get the optional descriptive comment for a LUN.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> comment |  | string | Comment for given LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_ENOMEM |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_NO_SUCH_ATTRIBUTE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-get-geometry | [top]

> Get SCSI disk geometry for a given LUN.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> bytes-per-sector | [0..2^31-1] | integer | Sector size in bytes.
> cylinders | [0..2^31-1] | integer | Number of cylinders in the LUN The size of the LUN can be calculated like this: cylinders tracks-per-cylinder sectors-per-track X bytes-per-sector --------------------- size
> max-resize-size | [0..2^63-1] | integer | The maximum size this LUN can be resized to in bytes. LUN resize is limited by the lun cylinder size which can not be increased beyond 65535. This number is calculated using a cylinder count of 65535, in place of the LUNs actual cylinder size.
> sectors-per-track | [0..2^31-1] | integer | Number of sectors in a track.
> size | [0..2^63-1] | integer | LUN size in bytes.
> tracks-per-cylinder | [0..2^31-1] | integer | Number of tracks in a cylinder. This is also commonly referred to as the number of heads.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-get-inquiry-info | [top]

> Get the SCSI INQUIRY response data for vendor id (vid), product id (pid), and firmware revision (rev) based on the igroup that the lun in question is mapped to.

> Input Name | Range | Type | Description
> initiator-group-name |  | string | The initiator group for which the vid/pid/rev information is to be returned.
> Output Name | Range | Type | Description
> firmware-revision |  | string | SCSI INQUIRY response revision (padded with spaces to 4-characters).
> product-id |  | string | SCSI INQUIRY response product id (padded with spaces to 16-characters).
> vendor-id |  | string | SCSI INQUIRY response vendor id (padded with spaces to 8-characters).

> Errno | Description
> EVDISK_ERROR_NO_SUCH_INITGROUP |  |

> Vfiler-enabled
> Yes

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..100] | 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..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

lun-get-maxsize | [top]

> Returns the maximum possible size in bytes of a lun on a given volume or qtree. The user can pass the path to a volume or qtree in which the lun is to be created. This returns the maximum size for different types of luns and the possible maximum size with or without snapshot reserves.

> Input Name | Range | Type | Description
> path |  | string | Path of the volume or qtree.
> type |  | lun-os-type | OS type of the LUN.
> Output Name | Range | Type | Description
> with-complete-snapshot-reserve | [0..2^63-1] | integer | Maximum possible size for LUN with snapshot reserve assuming 100% fractional reserve
> with-snapshot-reserve | [0..2^63-1] | integer | Maximum possible size for LUN with snapshot reserve.
> without-snapshot-reserve | [0..2^63-1] | integer | Maximum possible size for LUN without snapshot reserve.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EINVAL |  |
> EONTAPI_ENOENT |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-get-minsize | [top]

> Returns the minimum possible size in bytes. This returns the minimum size for different types of luns (based on the specified OS type). Space reservation does not affect the minimum lun size, thus only a single minimum size is returned.

> Input Name | Range | Type | Description
> type |  | lun-os-type | OS type of the LUN.
> Output Name | Range | Type | Description
> min-size | [0..2^63-1] | integer | Minimum possible size for LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |

lun-get-occupied-size | [top]

> Get the size occupied by the LUN in the active FS.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> occupied-size | [0..2^63-1] | integer | Size occupied by the LUN in the Active FS in bytes.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_ENOMEM |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EONTAPI_ESTALE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-get-persistent-reservation-info | [top]

> Get the persistent reservation information for a given LUN.

> Input Name | Range | Type | Description
> path |  | string | Path of the lun. The path should start with '/vol/'.
> Output Name | Range | Type | Description
> persistent-reservation |  | persistent-reservation-info[] optional | This is the persistent reservation information for a given I_T nexus if any exist for the given lun. The communication path and state between an initiator and a target is called an Initiator_Target Nexus, or I_T Nexus. The I_T Nexus is the owner of the persistent reservation information. There can be several I_T Nexus that have registered per lun. Each I_T Nexus can only register one time per lun.

> Errno | Description
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EONTAPI_ENOMEM |  |
> EINVALIDINPUTERROR |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-get-select-attribute | [top]

> Get the select attribute for the specified LUN.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> creation-timestamp | [0..2^31-1] | integer | The time this lun was created, in seconds since January 1, 1970. This field is available in Data ONTAP 8.1 and later.
> previous-serial |  | string optional | The serial number of the previous lun. If this lun is not a clone or copy, no previous-serial number exists.
> select-attribute |  | string | The select attribute for the lun. Possible values: "active" - this is an active lun, "copy" - this is a clone or copy of an active lun, "mirror" - this is a mirror of an active lun.

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

> Vfiler-enabled
> Yes

lun-get-serial-number | [top]

> Get the serial number for the specified 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 /-#$%&*+<=>?[!]^~@ .

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> serial-number |  | string | Serial number for the LUN.

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

> Vfiler-enabled
> Yes

lun-get-space-reservation-info | [top]

> Queries the space reservation settings for the named LUN.

> Input Name | Range | Type | Description
> path |  | string | Name of the LUN to be queried.
> Output Name | Range | Type | Description
> is-enabled |  | boolean | Whether or not the LUN has space reservation enabled.

> Errno | Description
> EFILENOTFOUND |  |
> EINTERNALERROR |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |

> Vfiler-enabled
> Yes

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 |  |

> Vfiler-enabled
> Yes

lun-has-scsi-reservations | [top]

> Queries for all types of scsi reservations covering both iSCSI and FCP.

> Input Name | Range | Type | Description
> path |  | string | Path of the lun. The path should start with '/vol/'.
> Output Name | Range | Type | Description
> is-reservation-held |  | boolean | 'true' if given LUN has a scsi-2 or scsi-3 style reservation held, 'false' otherwise.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |

> Vfiler-enabled
> Yes

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[] | List of lun maps for the given initiator.

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

> Vfiler-enabled
> Yes

lun-initiator-logged-in | [top]

> Determine if an initiator is logged in via FCP or iSCSI.

> Input Name | Range | Type | Description
> initiator |  | string | Name of FCP or iSCSI initiator to check.
> Output Name | Range | Type | Description
> is-logged-in |  | boolean | true if initiator is logged into the filer, false otherwise.

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

> Vfiler-enabled
> Yes

lun-map | [top]

> Maps the LUN to all the initiators in the specified initiator group.

> Input Name | Range | Type | Description
> force |  | boolean optional | Forcibly map the lun, disabling mapping conflict checks with the high-availability partner. If not specified all conflict checks are performed. In Data ONTAP Cluster-Mode, this field is accepted for backwards compatibilty and is ignored.
> initiator-group |  | string | Initiator group to map to the given LUN.
> lun-id | [0..4095] | integer optional | If the lun-id is not specified, the smallest number that can be used for the various initiators in the group is automatically picked.
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> lun-id-assigned | [0..4095] | integer | LUN ID assigned for this map. If lun-id is not supplied, this will be an auto-assigned LUN ID, otherwise it will be the same as the supplied LUN ID if map is successful.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EVDISK_ERROR_INITGROUP_HAS_VDISK |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_NO_EXPORTED_VDISK_SHARE_WRITE |  |
> EVDISK_ERROR_PARTNER_HAS_LUN |  |
> EVDISK_ERROR_PARTNER_NOT_REACHABLE |  |
> EVDISK_ERROR_LUN_HAS_ALUA_ENABLED_ISCSI_IGROUP |  |
> EVDISK_ERROR_LUN_HAS_ALUA_ENABLED_FCP_IGROUP |  |
> EVDISK_ERROR_LUN_HAS_ISCSI_IGROUP |  |
> EVDISK_ERROR_LUN_HAS_FCP_IGROUP |  |
> EVDISK_ERROR_LUN_HAS_ALUA_CONFLICTS |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

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..100] | 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..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

lun-map-list-info | [top]

> Returns a list of initiator groups and their members (the initiators) mapped to the given LUN.

> Input Name | Range | Type | Description
> path |  | string | LUN for which the initiator group list is requested.
> Output Name | Range | Type | Description
> initiator-groups |  | initiator-group-info[] | List of initiator groups that are mapped to the given LUN.

> Errno | Description
> EFILENOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-move | [top]

> Move (rename) a LUN.

> Input Name | Range | Type | Description
> new-path |  | string | New path of the LUN being moved to.
> path |  | string | Path of the LUN to be moved.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EISDIR |  |
> EONTAPI_EEXIST |  |
> EOFFLINE |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_NOT_QTREE_ROOT |  |
> EVDISK_ERROR_NOT_IN_SAME_VOLUME |  |
> EVDISK_ERROR_VDISK_EXISTS |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-offline | [top]

> Disables block-protocol accesses to the LUN. Mappings, if any, configured for the lun are not altered. Note that unless explicitly offlined, a lun is online.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.

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

> Vfiler-enabled
> Yes

lun-online | [top]

> Re-enables block-protocol accesses to the lun.

> Input Name | Range | Type | Description
> force |  | boolean optional | Forcibly online the lun, disabling mapping onflict checks with the high-availability partner. If not specified all conflict checks are performed. In Data ONTAP Cluster-Mode, this field is accepted for backwards compatibility and is ignored.
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_VDISK_NOT_DISABLED |  |
> EVDISK_ERROR_NO_EXPORTED_VDISK_SHARE_WRITE |  |
> EVDISK_ERROR_PARTNER_HAS_LUN |  |
> EVDISK_ERROR_PARTNER_NOT_REACHABLE |  |
> EVDISK_ERROR_LUN_HAS_NO_SERIAL_NO |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-port-has-scsi-reservations | [top]

> Queries for all types of scsi reservations covering both iSCSI and FCP for a given initiator name. Initiator name can be FCP portname in case of FCP or ISCSI nodename for ISCSI.

> Input Name | Range | Type | Description
> path |  | string | Path of the lun. The path should start with '/vol/'.
> portname |  | string | Initiator FCP portname or ISCSI nodename .
> Output Name | Range | Type | Description
> is-reservation-held |  | boolean | 'true' if given LUN has a scsi-2 or scsi-3 style reservation held, 'false' otherwise.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |

> Vfiler-enabled
> Yes

lun-resize | [top]

> Changes the size of the lun. Note that client-side operations may be needed to ensure that client software recognizes the changed size.

> Input Name | Range | Type | Description
> force |  | boolean optional | Forcibly reduce the size. This is required for reducing the size of the LUN to avoid accidentally reducing the LUN size.
> path |  | string | Path of the LUN.
> size | [0..2^63-1] | integer | New size for the LUN.
> Output Name | Range | Type | Description
> actual-size | [0..2^63-1] | integer | Actual new size. This may be different from the specified size due to the requested size not fitting on a cylinder boundary.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_SIZE_TOO_LARGE |  |
> EVDISK_ERROR_RESIZE_TOO_LARGE |  |
> EONTAPI_NOSPC |  |
> EVDISK_ERROR_MUST_SPECIFY_F_FLAG |  |
> EVDISK_ERROR_SIZE_TOO_SMALL |  |
> EVDISK_ERROR_SIZE_UNCHANGED |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-set-attribute | [top]

> Set a named attribute for a given LUN. Attributes are arbitrary key/value pairs for application-defined use.

> Input Name | Range | Type | Description
> name |  | string | Application-defined attribute to set. In order to prevent conflicts between separate applications, it is recommended that applications prefix attribute names with their registered Internet domain name reversed component by component, and an application identifier. For example: "com.example.widgetapp.attribute". The following attributes are reserved by the system and may not be set: "custom", "cylinder_size", "dev_id", "enabled", "extent_size", "host_stamp", "path_last", "pserial", "pSerial", "serial", "snapshot", "snapshot_path_last", "type". In older versions of Data ONTAP, attempting to set a system-reserved attribute may adversely affect data integrity and availability of the storage system. Clients of this API must therefore take special care to not use any system-reserved attribute names.
> path |  | string | Path of the LUN.
> value |  | string | Value to set the attribute to.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EONTAPI_EPERM |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-set-comment | [top]

> Set the optional descriptive comment for a LUN.

> Input Name | Range | Type | Description
> comment |  | string | Comment to set for given LUN.
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_ENOMEM |  |
> EONTAPI_EROFS |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_NO_SUCH_ATTRIBUTE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-set-device-id | [top]

> Set a SCSI peripheral device identifying information value on a LUN. In Data ONTAP 7-Mode, the value set will be returned in response to the vendor unique SCSI command GET DEV ID. In Data ONTAP Cluster-Mode, the value set will be returned in response to the SCSI command REPORT IDENTIFYING INFORMATION for the appropriate INFORMATION TYPE: 0000000b - Peripheral Device Identifying Information, a binary string 1 to 64 bytes long. In addition, if the Peripheral Device Identifying Information is between 00000001h (1d) and 0000270Fh (9999d), it will be returned in response to the vendor unique SCSI command GET DEV ID. 0000010b - Peripheral Device Text Identifying Information, a UTF-8 string 1 to 255 bytes long. Either or both peripheral device identifying information values may be set or cleared independently.

> Input Name | Range | Type | Description
> device-id |  | string | SCSI Peripheral Device Identifying Information. In Data ONTAP 7-Mode or if device-id-type is "legacy", the value must be an integer in the range [1..9999]. If device-id-type is "binary", the value must be a 1 to 64 byte value encoded as a hexadecimal string, for example "0000270F". If device-id-type is "text", the value is a free-form UTF-8 string between 1 and 255 bytes in length.
> device-id-type |  | string optional | Indicate which peripheral device identifying information value to change. Possible values: "legacy" - Set the Peripheral Device Identifying Information for REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b) appropriate for the the vendor unique SCSI command GET DEV ID and in the format compatible with Data ONTAP 7-Mode, "binary" - Set the Peripheral Device Identifying Information for REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b). This format allows setting all 64 bytes of the identifying information, "text" - Set the Peripheral Device Text Identifying Information for REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b). The default value is "legacy".
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> VDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_VDISK_NOT_DISABLED |  |
> EVDISK_ERROR_INVALID_DEVICE_ID |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-set-select-attribute | [top]

> Set the select attribute for the specified LUN. The select attribute is used by mult-pathing software to discriminate between luns when mirrored or cloned copies of a vdisk are mapped to the same host.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> select-value |  | string | Sets the select attribute for the lun. Possible values: "active" - this is an active lun, "copy" - this is a clone or copy of an active lun, "mirror" - this is a mirror of an active lun.

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

> Vfiler-enabled
> Yes

lun-set-serial-number | [top]

> Set the serial number for the specified LUN. The lun must first be made offline before changing the serial number. 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 /-#$%&*+<=>?[!]^~@ .

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> serial-number |  | string | Serial number for the LUN.

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

> Vfiler-enabled
> Yes

lun-set-space-alloc | [top]

> Modify the attributes of lun object.

> Input Name | Range | Type | Description
> enable |  | boolean | LUN space alloc setting
> path |  | string | Path of the LUN

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

lun-set-space-reservation-info | [top]

> Sets the space reservation settings for the named LUN.

> Input Name | Range | Type | Description
> enable |  | boolean | Enable or disable space reservation on this LUN.
> path |  | string | Path to the LUN for which the space reservations need to be set.

> Errno | Description
> EFILENOTFOUND |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ESETSPCRESERROR |  |
> EONTAPI_ENOSPC |  |
> EVOLUMEBUSY |  |
> EVOLUMEDOESNOTEXIST |  |

> Vfiler-enabled
> Yes

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..100] | 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..100] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

lun-unmap | [top]

> Reverses the effect of lun-map on the specified LUN for the specified group.

> Input Name | Range | Type | Description
> initiator-group |  | string | Initiator group to unmap from.
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_NO_EXPORTED_VDISK_SHARE_WRITE |  |
> EVDISK_ERROR_NO_SUCH_EXPORT |  |
> EVDISK_ERROR_NO_SUCH_INITGROUP |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-unset-attribute | [top]

> Clear a named attribute for a given LUN.

> Input Name | Range | Type | Description
> name |  | string | Name of attribute to unset. The following attributes are reserved by the system and may not be unset: "custom", "cylinder_size", "dev_id", "enabled", "extent_size", "host_stamp", "path_last", "pserial", "pSerial", "serial", "snapshot", "snapshot_path_last", "type". In older versions of Data ONTAP, attempting to unset a system-reserved attribute may adversely affect data integrity and availability of the storage system. Clients of this API must therefore take special care to not use any system-reserved attribute names.
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EONTAPI_EPERM |  |
> EVOLUMEBUSY |  |
> EVDISK_ERROR_NO_SUCH_ATTRIBUTE |  |

> Vfiler-enabled
> Yes

lun-unset-device-id | [top]

> Remove a SCSI peripheral device identifying information value from a LUN.

> Input Name | Range | Type | Description
> device-id-type |  | string optional | Indicate which peripheral device identifying information to remove. Possible values: "binary" - Remove the Peripheral Device Identifying Information returned in response to the SCSI commands REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b) and GET DEV ID, "text" - Remove the Peripheral Device Text Identifying Information returned in response to the SCSI command REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b). The default value is "binary".
> path |  | string | Path of the LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |
> VDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_VDISK_NOT_DISABLED |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

Element definition: initiator-group-info | [top]

> Information about an initiator group.

> Name | Range | Type | Description
> initiator-group-alua-enabled |  | boolean | Boolean value to indicate if this initiator group has ALUA (Asymmetric Logical Unit Access) features enabled for luns mapped to this initiator group.
> initiator-group-name |  | string | Name of this initiator group.
> initiator-group-os-type |  | initiator-group-os-type | OS type of the initiator group
> initiator-group-portset-name |  | string optional | Name of the portset that is bound to the initiator group, if any.
> initiator-group-throttle-borrow |  | boolean | Boolean value to indicate that the igroups throttle reserve may be exceeded if the igroup attempts to use more than it has reserved.
> initiator-group-throttle-reserve |  | integer | Percentage of filer SCSI command blocks reserved for this initiator group's exclusive usage.
> initiator-group-type |  | string | Type of the initiators in this group. Possible values: "iscsi", "fcp", "mixed".
> initiator-group-use-partner |  | boolean optional | Boolean value to indicate if this initiator group is configured for its luns to require the use of host multi-pathing software for correct high-availability failover operation. In Data ONTAP 7-Mode, this value is optional and is only returned for FCP initiator groups on an storage system in an HA pair. In Data ONTAP Cluster-Mode, this field will always be 'true'.
> initiator-group-uuid |  | string optional | This value is Universally-unique identifier (UUID) of this initiator group. The UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hexadecimal characters, the second through fourth groupings have four hexadecimal characters each, and the fifth and final grouping has 12 hexadecimal characters. Note that a leading '0x' is not used. This field is available in Data ONTAP 7-mode 7.3.6, 8.0.2, 8.1.0 and later for the igroup-list-info API. This field is available in Data ONTAP Cluster-Mode 8.1.0 and later for the igroup-get-iter and lun-map-list-info APIs. Here is an example of an actual UUID: 35d6ca90-c759-11df-8b6d-00a098132c6c
> initiator-group-vsa-enabled |  | boolean | Boolean value to indicate if this initiator group has Volume Set Addressing (VSA) enabled or disabled.
> initiators |  | initiator-info[] | List of initiators belonging to this group.
> lun-id | [0..4095] | integer optional | LUN identifier to which the LUN is mapped at the host. This value is optional and is only returned for the lun-map-list-info api.
> vserver |  | string optional | Name of the vserver hosting this initiator group

Element definition: lun-info | [top]

> Information of a LUN.

> Name | Range | Type | Description
> alignment |  | string | Alignment of the LUN. Possible values: "aligned", "misaligned" 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 | Disk block size of the LUN in bytes.
> clone-backing-snapshot |  | string optional |
> comment |  | string | User-specified comment for the LUN.
> creation-timestamp | [0..2^31-1] | integer | The time this LUN was created, in seconds since January 1, 1970.
> 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-space-alloc-enabled |  | boolean | Whether or not the LUN has space allocation enabled.
> is-space-reservation-enabled |  | boolean | Whether or not the LUN has space reservation enabled.
> mapped |  | boolean | Whether or not the LUN is mapped to any initiators. "true" if mapped, "false" otherwise.
> multiprotocol-type |  | lun-os-type | OS type of the LUN
> 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 | 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 available in Data ONTAP 8.1 and later.
> qtree |  | string | Name of the qtree containing the LUN.
> read-only |  | boolean | "true" if the LUN is read only, "false" if read/write.
> serial-number |  | string | 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 /-#$%&*+<=>?[!]^~@ .
> 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 | Size of this LUN in bytes in the active FS.
> size-used | [0..2^63-1] | integer | Number of bytes used by this LUN.
> staging |  | boolean | "true" if the LUN is a temporary staging LUN, "false" otherwise.
> suffix-size | [0..2^63-1] | integer | 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 available in Data ONTAP 8.1 and later.
> uuid |  | string | Universal unique identifier (UUID) for the LUN.
> 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-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: lun-stats-info | [top]

> Stats for a LUN.

> Name | Range | Type | Description
> block-size |  | integer | Disk block size for this LUN in bytes.
> 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 | Number of disk blocks read.
> 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 | Number of disk blocks written.
> write-ops | [0..2^64-1] | integer | Total number of SCSI write ops executed.

Element definition: persistent-reservation-info | [top]

> Information about the persistent reservation

> Name | Range | Type | Description
> fcp-pr-nexus |  | fcp-pr-nexus optional | This is the I_T_Nexus info for an fcp type reservation.
> iscsi-pr-nexus |  | iscsi-pr-nexus optional | This is the I_T_Nexus info for an iscsi type reservation.
> reservation-key |  | string | Value of persistent reservation key that is registered for the given lun.
> reservation-type |  | string | Type of persistent reservation. Possible values: "fcp", "iscsi".
> reservation-type-code |  | string optional | Type of persistent reservation held by the I_T_Nexus, if any. Please refer to the SCSI Primary Command (SPC) specification for full details on reservation types. Possible values: "read shared", "write exclusive", "exclusive access", "write exclusive registrants only", "exclusive access registrants only", "write exclusive all registrants", "exclusive access all registrants".
> scsi-revision |  | string | The SCSI specification revision for the reservation. Possible values: "scsi2", "scsi3".

Element definition: fcp-pr-nexus | [top]

> Information about fcp nexus owning the persistent reservation These two componients identify the relationship between the FCP initiator and the target.

> Name | Range | Type | Description
> initiator-port |  | string | FCP initiator port part of I_T_Nexus owning the persistent reservation key.
> target-port |  | string | FCP target port part of I_T_Nexus owning the persistent reservation key.
> third-party-initiator-port |  | string optional | The FCP port name (WWPN) of the third-party initiator the reservation is being held for. For use in SCSI-2 only.

Element definition: initiator-group-os-type | [top]

> The operating system of the initiator group. This value modifies the finer details of SCSI protocol interaction for initiators in the group. Possible values: "aix" The initiators belong to an AIX host, "default" The initiators belong to an unknown host type, "hpux" The initiators belong to an HP-UX host, "hyper_v" The initiators belong to a Hyper-V parent host, "linux" The initiators belong to a Linux host, "netware" The initators belong to a NetWare host, "openvms" The initiators belong to an OpenVMS host, "solaris" The initiators belong to a Solaris host, "vmware" The initiators belong to a VMware ESX host, "windows" The initiators belong to a Windows host, "xen" The initiators belong to a Xen hypervisor host.

> [none]

Element definition: initiator-info | [top]

> Information about one initiator.

> Name | Range | Type | Description
> initiator-name |  | string | Name of the initiator.

Element definition: iscsi-pr-nexus | [top]

> Information about iscsi nexus owning the persistent reservation These three componients identify the relationship between the iSCSI initiator and the target.

> Name | Range | Type | Description
> initiator |  | string | Name of initiator holding the reservation i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346.
> isid |  | string | The Initiator Session ID for the persistent reservation owner. The ISID is a numeric Initiator Session ID assigned by the initiator which acts as part of the initiators identity.
> third-party-initiator-name |  | string optional | The name of the third-party initiator the reservation is being held for. For use in SCSI-2 only. i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346.
> tpgroup-tag | [0..2^16-1] | integer | The target portal group tag of the persistent reservation owner.