APIs in Category: lun | API version 1.13

file-get-space-reservation-info file-set-space-reservation-info lun-clear-persistent-reservation-info lun-clone-list-info lun-clone-split-start lun-clone-split-status-list-info lun-clone-split-stop lun-clone-start lun-clone-status-list-info lun-clone-stop lun-config-check-alua-conflicts-info lun-config-check-cfmode-info lun-config-check-info lun-config-check-single-image-info lun-create-by-size lun-create-clone lun-create-from-file lun-create-from-snapshot lun-destroy lun-get-attribute lun-get-comment lun-get-geometry lun-get-inquiry-info 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-target-device-id lun-get-vdisk-attributes lun-has-scsi-reservations lun-initiator-list-map-info lun-initiator-logged-in lun-list-info lun-map lun-map-list-info lun-move lun-offline lun-online lun-port-has-scsi-reservations lun-reset-stats lun-resize lun-restore-status lun-set-attribute lun-set-comment lun-set-device-id lun-set-select-attribute lun-set-serial-number lun-set-share lun-set-space-reservation-info lun-snap-usage-list-info lun-start lun-stats-list-info lun-unmap lun-unset-attribute lun-unset-device-id

NetApp Manage ONTAP

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

> Queries the space reservation settings for the named file.

> Input Name | Range | Type | Description
> path |  | string | File to be queried.
> Output Name | Range | Type | Description
> is-fill-enabled |  | boolean | Whether or not the file is set with fill.
> is-overwrite-enabled |  | boolean | Whether or not the file is set with overwrite.

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

> Vfiler-enabled
> Yes

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

> Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.

> Input Name | Range | Type | Description
> is-fill-enabled |  | string optional | Whether or not to set the file with fill.
> is-overwrite-enabled |  | boolean optional | Whether or not to set the file with overwrite.
> path |  | string | File to be queried.

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

> Vfiler-enabled
> Yes

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

> Clear the SCSI-2 reservation or SCSI-3 persistent reservation information for a given LUN.

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

> Vfiler-enabled
> Yes

lun-clone-list-info | [top]

> Lists all LUN clones with valid backing snapshots in the given snapshot.

> Input Name | Range | Type | Description
> snapshot |  | string | Name of the snapshot.
> volume |  | string | Name of the volume.
> Output Name | Range | Type | Description
> lun-clone-list |  | lun-clone-lists-info[] | List of LUN clones with valid backing snapshots in the given snapshot.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVOLUMEMOUNTING |  |
> EVOLUMEOFFLINE |  |
> EVDISK_ERROR_NO_SUCH_VOLUME |  |
> EVDISK_ERROR_NO_SUCH_SNAPSHOT |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-clone-split-start | [top]

> Start the cloning of the given LUN.

> Input Name | Range | Type | Description
> path |  | string | Path of the clone to split from the underlying parent.
> space-efficient-split-disabled |  | boolean optional | By default 'false', space-efficient LUN clone splitting is allowed. This parameter, if set to 'true', disables space-efficient splitting for this specific operation.

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

> Vfiler-enabled
> Yes

lun-clone-split-status-list-info | [top]

> Get the cloning status of LUN(s).

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> clone-status |  | clone-status-info[] | List of cloning statuses.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVDISK_ERROR_NO_SUCH_ATTRIBUTE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-clone-split-stop | [top]

> Stop the cloning of the given LUN.

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

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

> Vfiler-enabled
> Yes

lun-clone-start | [top]

> Start the cloning of the given LUN.

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

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

> Vfiler-enabled
> Yes

lun-clone-status-list-info | [top]

> Get the cloning status of LUN(s).

> Input Name | Range | Type | Description
> path |  | string optional | Path of the LUN. If path is specified, only the status of that clone is retuned. If path is not specified, then all cloning status are returned.
> Output Name | Range | Type | Description
> clone-status |  | clone-status-info[] | List of cloning status.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |
> EVDISK_ERROR_NO_SUCH_ATTRIBUTE |  |
> EVDISK_ERROR_NO_SUCH_CLONE |  |
> EVDISK_ERROR_CLONE_NOT_SPLITTING |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-clone-stop | [top]

> Stop the cloning of the given LUN.

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

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

> Vfiler-enabled
> Yes

lun-config-check-alua-conflicts-info | [top]

> Returns a list of luns that have both FCP and ISCSI maps at the same time when ALUA is enabled on atleast one of such FCP or ISCSI igroups. These conflicts must be resolved before any further maps (to those luns) can can take place.

> Output Name | Range | Type | Description
> conflicting-luns |  | conflicting-luns-list[] optional | If a lun is mapped to both FCP and iSCSI igroups at at the same time with ALUA enabled on atleast one of those igroups, it leads to a conflict. These conflicts need to be resolved before any further maps can take place to the conflicting lun. Conflicts can either be resolved by unmapping one or more mappings or by disabling ALUA on FCP or iSCSI or both the igroups whichever is applicable.

> Errno | Description
> EVDISK_ERROR_NO_SUCH_INITGROUP; |  |

lun-config-check-cfmode-info | [top]

> Returns a list of configuration warnings related to initiator groups and the fcp cfmode setting

> Output Name | Range | Type | Description
> fcp-cfmode |  | string optional | Current FCP cfmode setting. Possible values: dual_fabric, mixed, partner, standby, single_image
> invalid-cfmode-settings |  | invalid-cfmode-setting-info optional | Local and partner cfmode settings if they do not match. cfmodes need to match on both filers in the cluster or cluster failover will not work properly
> invalid-ostype-cfmode-settings |  | invalid-ostype-cfmode-setting-info[] optional | List of initiator groups with invalid ostypes for the fcp-cfmode. Some host operating systems are only compatible with certain fcp-cfmodes
> invalid-use-partner-cfmode-settings |  | invalid-use-partner-cfmode-setting-info[] optional | List of initiator groups with invalid use_partner settings for the FCP cluster failover mode (fcp-cfmode) Incorrect settings can cause hosts to lose luns during takeover.
> invalid-use-partner-ostype-settings |  | invalid-use-partner-ostype-setting-info[] optional | List of initiator groups with invalid use_partner settings for the initiator group's ostype. Some host operating systems should only have certain use_partner settings to ensure proper behavior during failover.

> Errno | Description
> EINTERNALERROR |  |
> EINVAL |  |

lun-config-check-info | [top]

> Returns a list of lun/fcp configuration warnings. These warnings are not related to filer cluster configuration.

> Output Name | Range | Type | Description
> alua-setting-mismatch-info |  | alua-setting-mismatch-initiator-group[] optional | list of initiator groups for which the ALUA (Asymmetric Logical Unit Access) settings do not match between local and partner filers. ALUA is a T10 standard that specifies the access characteristics (in terms of performance and supported SCSI commands) of a Logical Unit that can be accessed through more than one target port. ALUA is typically used by host multi-path software to recognize primary and secondary paths to a Logical Unit when more than one path are available to the Logical Unit. If the ALUA setting does not match between the local and partner filers, it would affect the host multi-path software's ability to distingush primary and secondary paths. This could lead to incorrect system behaviour.
> alua-setting-mismatch-initiators |  | alua-setting-mismatch-initiator-info[] optional | List of initiators which are members of initiator groups of differing alua settings.
> fcp-down-hbas |  | fcp-down-hba-info[] optional | list of HBA names that have no link or are configured down.
> invalid-vsa-settings |  | invalid-vsa-setting-info[] optional | List of initiator groups with invalid VSA settings
> mixed-ostype-initiators |  | mixed-ostype-initiator-info[] optional | List of initiators which are members of initiator groups of differing ostypes.
> mixed-vsa-initiators |  | mixed-vsa-initiator-info[] optional | List of initiators which are members of initiator groups with differing VSA settings. An initiator can only be a member of initiator groups which have the same VSA setting across all the initiator groups it is a member of.

> Errno | Description
> EINTERNALERROR |  |
> EINVAL |  |

lun-config-check-single-image-info | [top]

> Returns a list of configuration warnings that pertain to problems specific to the 'single_image' fcp cfmode. These errors must befixed prior to upgrading any filer cluster to run in 'single_image' mode.

> Output Name | Range | Type | Description
> conflicting-initiators |  | conflicting-initiator-info[] optional | List of initiators which belong to initiator groups on the local filer which have different os type settings from the initiator groups on the partner.
> conflicting-maps |  | conflicting-map-info[] optional | Only one lun in the cluster can be mapped to an initiator at a given lun-id. If a lun on each filer is mapped to the same initiator at the same lun-id there will be a conflict. These conflicts need to be resolved before a filer can be upgraded to run in the 'single_image' fcp cfmode. A conflict can be resolved by unmapping one lun and remapping it to an unused lun-id.
> invalid-nodename-settings |  | invalid-nodename-setting-info optional | When running in the the single_image cfmode the fcp nodename needs to be same on each filer in the cluster. If the nodenames are different the nodenames will be returned. If the cfmode is not set to single_image, then the nodenames will not be checked

> Errno | Description
> EVDISK_ERROR_PARTNER_NOT_REACHABLE |  |

lun-create-by-size | [top]

> Create a new lun of given size, with initially zero contents. The lun is created at the lun_path given. No file should already exist at the given lun_path. The directory specified in the lun_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 |  | string optional | The ostype for the LUN. While optional, the caller should specify a non-default ostype. Please see Note below. Currently, supported ostypes are "solaris" (the lun will be used to store a Solaris raw disk in a single-slice partition), "windows" (the lun will be used to store a raw disk device in a single-partition Windows disk), "hpux" (the lun will be used to store HP-UX data), "aix" (the lun will be used to store AIX data), "linux" (the lun will be used to store a Linux raw disk without any partition table), "netware" (the lun will be used to store NetWare data), "vmware" (the lun will be used to store VMWARE data), "windows_gpt" (the lun will be used to store Windows data using the GPT (GUID Partiton Type) partitioning style), "windows_2008" (the lun will be used to store Windows data on Windows 2008 systems), "openvms" (the lun will be used to store OpenVMS data), "image" (the default ostype, indicating that no assumptions can be made about the contents in the lun). If the ostype argument is properly specified to reflect the use to which the lun will be put, it will be possible to access the same data (raw disk data) over both SCSI and network file system protocols: NFS, CIFS, DAFS. *NOTE* It is strongly recommended for the caller of this API to avoid using the "default" type because it could result in misconfigured LUNs. For example, a lun with ostype "default" could suffer major performance penalties when a Windows host is trying to access it. The caller should obtain as much information about the OS types for which the luns are being created.
> path |  | string | Path of the LUN.
> 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-clone | [top]

> Create a LUN clone.

> Input Name | Range | Type | Description
> parent-lun-path |  | string | Path of original LUN.
> parent-snap |  | string | LUN path of the backing snapshot.
> path |  | string | Path of the LUN clone.
> 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.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EONTAPI_ENOMEM |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_CLONING_STARTED |  |
> 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 |  | string optional | Type of LUN. While optional, the caller should specify a non-default ostype. Please see Note below. Currently, supported ostypes are "solaris" (the lun will be used to store a Solaris raw disk in a single-slice partition), "windows" (the lun will be used to store a raw disk device in a single-partition Windows disk), "hpux" (the lun will be used to store HP-UX data), "aix" (the lun will be used to store AIX data), "linux" (the lun will be used to store a Linux raw disk without any partition table), "netware" (the lun will be used to store NetWare data), "vmware" (the lun will be used to store VMWARE data), "windows_gpt" (the lun will be used to store Windows data using the GPT (GUID Partiton Type) partitioning style), "windows_2008" (the lun will be used to store Windows data on Windows 2008 systems), "openvms" (the lun will be used to store OpenVMS data), "image" (the default type, indicating that no assumptions can be made about the contents in the lun). If the ostype argument is properly specified to reflect the use to which the lun will be put, it will be possible to access the same data (raw disk data) over both SCSI and network file system protocols: NFS, CIFS, DAFS. *NOTE* It is strongly recommended for the caller of this API to avoid using the "default" ostype because it could result in misconfigured LUNs. For example, a lun with ostype "default" could suffer major performance penalties when a Windows host is trying to access it. The caller should obtain as much information about the OS types for which the luns are being created.
> path |  | string | Would be Path of the newly created LUN if successful. This Path must not exists 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-create-from-snapshot | [top]

> Creates a LUN in the active file system. The lun has the same initial contents as the referenced snapshot copy of an existing lun. (Note that no copy of the data is made.) Future writes go into the new lun. Reads of unmodified data are satisfied from the snapshot location. Reads of modified data are satisfied by first attempting to find the required buffer in the new lun. If a buffer is not found (buffer corresponds to a hole), it is looked for in the snapshot copy instead.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> snapshot-lun-path |  | string | LUN path in the snapshot to be created from.
> 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.
> type |  | string optional | Type of LUN. While optional, the caller should specify a non-default type. Please see Note below. Currently, supported are "solaris" (the lun will be used to store a Solaris raw disk in a single-slice partition), "windows" (the lun will be used to store a raw disk device in a single-partition Windows disk), "hpux" (the lun will be used to store HP-UX data), "aix" (the lun will be used to store AIX data), "linux" (the lun will be used to store a Linux raw disk without any partition table), "netware" (the lun will be used to store NetWare data), "vmware" (the lun will be used to store VMWARE data), "windows_gpt" (the lun will be used to store Windows data using the GPT (GUID Partiton Type) partitioning style), "windows_2008" (the lun will be used to store Windows data on Windows 2008 systems), "openvms" (the lun "openvms" (the lun will be used to store OpenVMS data), "image" (the default type, indicating that no assumptions can be made about the contents in the lun). If the type argument is properly specified to reflect the use to which the lun will be put, it will be possible to access the same data (raw disk data) over both SCSI and network file system protocols: NFS, CIFS, DAFS. *NOTE* It is strongly recommended for the caller of this API to avoid using the "default" type because it could result in misconfigured LUNs. For example, a lun with type "default" could suffer major performance penalties when a Windows host is trying to access it. The caller should obtain as much information about the OS types for which the luns are being created.
> 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 | Forcibly destroy the LUN regardless of it being online or mapped.
> 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 |  |

> 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-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 |  | string | Maximum size of LUN for specified OS type. Current supported types are "solaris", "windows", "hpux", "aix", "vld", "linux", "netware", "vmware", "image", "windows_gpt", "windows_2008","openvms"
> 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 |  | string | Minimum size of LUN for specified OS type. Type of LUN. Current supported types are "solaris", "windows", "hpux", "aix", "vld", "linux", "image", "netware", "vmware", "windows_gpt", "windows_2008", "openvms".
> Output Name | Range | Type | Description
> min-size | 0..2^63-1 | integer | Minimum possible size for LUN.

> Errno | Description
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

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^64-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 pr 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-time |  | string | The time this lun was created
> previous-serial |  | string optional | The serial number of the previous lun. If this lun is not a clone or copy, no previous-serial number exsits.
> 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. The serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) 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-target-device-id | [top]

> Returns the SCSI Target Device Id.

> Input Name | Range | Type | Description
> lun-serial-id |  | string | Serial number of the lun.
> protocol |  | string | Transport protocol through which the lun will be accessed. Possible values are "fcp" or "iscsi".
> Output Name | Range | Type | Description
> target-device-id |  | string | SCSI Target Device Id. This is defined by Network Appliance. Currently a string of numbers preceded by "NETAPP TARGET ".

> Errno | Description
> EINVALIDINPUTERROR |  |

> Vfiler-enabled
> Yes

lun-get-vdisk-attributes | [top]

> Get path, volume name and filer name for the specified LUN.

> Input Name | Range | Type | Description
> serial-number |  | string | Serial number for the LUN.
> Output Name | Range | Type | Description
> filer-name |  | string | Name of the filer that owns the specified LUN.
> path |  | string | path for the specified LUN (for example, "/vol/vol0/lun1")
> vdisk-snapshot-name |  | string | Snapshot name for the specified LUN (for example, "/vol/vol0/.snapshot/lun")

> 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 | initiator to check
> Output Name | Range | Type | Description
> is-logged-in |  | boolean | true if initiator is logged into the filer

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

> Vfiler-enabled
> Yes

lun-list-info | [top]

> Get the status (size, online/offline state, shared state, comment string, serial number, LUN mapping) of the given LUN, or all LUNs.

> Input Name | Range | Type | Description
> get-clone-backing-snapshot |  | boolean optional | If specified, the name of the backing snapshot for a LUN clone is returned. The default value is false.
> path |  | string optional | Path of LUN. If specified, only the information of that LUN is returned. This option can only be used if volume-name is not used.
> volume-name |  | string optional | Name of a volume. If specified, only the information of the LUNs in that volume is returned. This option can only be used if path is not specified.
> Output Name | Range | Type | Description
> are-vols-busy |  | boolean | Indicates whether any volumes are moving. If true, the output of this command cannot be considered authoritative. Users needing authoritative data should retry until this output parameter is false.
> are-vols-onlining |  | boolean | Indicates whether any volumes are still in the process of onlining. If true, the output of this command cannot be considered authoritative. Users needing authoritative data should retry until this output parameter is false.
> luns |  | lun-info[] | Information of a list of LUNs.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> ENOSYS |  |
> EONTAPI_ENOMEM |  |
> EONTAPI_ESTALE |  |
> EVDISK_ERROR_VOLUMES_ONLINING |  |
> EVDISK_ERROR_NO_SUCH_VOLUME |  |
> EVOLUMEMOUNTING |  |
> EVOLUMEOFFLINE |  |
> EVOLUMEBUSY |  |

> 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 cluster partner. If not specified all conflict checks are performed.
> initiator-group |  | string | Initiator group to map to the given LUN.
> lun-id |  | 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 |  | 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-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 cluster partner. If not specified all conflict checks are performed.
> 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 portname.

> Input Name | Range | Type | Description
> path |  | string | Path of the lun. The path should start with '/vol/'.
> portname |  | string | Name of the port.
> 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-reset-stats | [top]

> Resets (zeroes) block-protocol access statistics for LUN(s).

> Input Name | Range | Type | Description
> path |  | string optional | Path of the LUN. If path is specified, the stats of that LUN will be reset. If path is not specified, stats of all LUNs are reset.

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

> 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-restore-status | [top]

> Get state of LUN restore.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> Output Name | Range | Type | Description
> is-running |  | boolean | 'true' if file restore is currently running for this vdisk, 'false' otherwise.

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

> Vfiler-enabled
> Yes

lun-set-attribute | [top]

> Set a named attribute for a given LUN.

> Input Name | Range | Type | Description
> name |  | string | Attribute to set. The following attributes may not be set: path_last enabled type cylinder_size custom extent_size serial host_stamp snapshot snapshot_path_last These attributes were mistakenly included in the first release of this API. They were not intended to be controllable by this API, and as of Data ONTAP 7.1 theses attributes can no longer be controlled by this API.
> 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 the SCSI Device Identifier for the Lun.

> Input Name | Range | Type | Description
> device-id |  | string | SCSI Device Identifier.
> 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 inputs: "active" - use this as the active lun "copy" - use this as a clone or copy of an active lun "mirror" - use this as 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. The serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) 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-share | [top]

> Enables file system protocol-based access to a lun. By default, all accesses are disallowed. Note that file permissions and ACL entries still apply.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN.
> share-type |  | string | Possible values: all, none, read, write

> Errno | Description
> EINVALIDINPUTERROR |  |
> VDISK_ERROR_NO_SUCH_VDISK |  |
> VDISK_ERROR_NO_EXPORTED_VDISK_SHARE_WRITE |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

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-snap-usage-list-info | [top]

> Lists all LUNs backed by data in the specified snapshot. It also lists the corresponding snapshots in which these LUNs exist.

> Input Name | Range | Type | Description
> snapshot |  | string | Name of the snapshot.
> volume |  | string | Name of the volume.
> Output Name | Range | Type | Description
> lun-snap-usage-luns |  | lun-snap-usage-lun-info[] | List of LUNs backed by data in the specified snapshot.

> Errno | Description
> EINVALIDINPUTERROR |  |
> EVOLUMEMOUNTING |  |
> EVOLUMEOFFLINE |  |
> EVDISK_ERROR_NO_SUCH_VOLUME |  |
> EVDISK_ERROR_NO_SUCH_SNAPSHOT |  |
> EVOLUMEBUSY |  |

> Vfiler-enabled
> Yes

lun-start | [top]

> Starts block-protocol accesses to the lun.

> Input Name | Range | Type | Description
> path |  | string | Path of the LUN. The path should start with '/vol/' (for example, "/vol/vol0/lun1").

> Errno | Description
> EINVALIDINPUTERROR |  |
> EONTAPI_EROFS |  |
> EONTAPI_ENOENT |  |
> EVDISK_ERROR_NO_SUCH_VDISK |  |
> EVDISK_ERROR_VDISK_NOT_STOPPED |  |

> Vfiler-enabled
> Yes

lun-stats-list-info | [top]

> Get block-protocol access statistics (in bytes) for LUN(s).

> Input Name | Range | Type | Description
> path |  | string optional | Path of the LUN. If path is specified, only the stats of that LUN is returned. If path is not specified, stats of all LUNs are returned.
> Output Name | Range | Type | Description
> lun-stats |  | lun-stats-info[] | List of LUN stats.

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

> Vfiler-enabled
> Yes

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 may not be unset: path_last enabled type cylinder_size custom extent_size serial host_stamp snapshot snapshot_path_last These attributes were mistakenly included in the first release of this API. They were not intended to be controllable by this API, and as of Data ONTAP 7.1 theses attributes can no longer be controlled by this API.
> path |  | string | Path of the LUN.

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

> Vfiler-enabled
> Yes

lun-unset-device-id | [top]

> Remove the SCSI Device Identifier from the Lun.

> Input Name | Range | Type | Description
> 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: alua-setting-mismatch-initiator-group | [top]

> Information about an initiator group that has an ALUA (Asymmetric Logical Unit Access) setting mismatch on local and partner filers.

> Name | Range | Type | Description
> initiator-group-name |  | string | name of the initiator group.
> local-alua-is-enabled |  | boolean | true if ALUA (Asymmetric Logical Unit Access) is enabled for initiator-group-name on the local filer.
> partner-alua-is-enabled |  | boolean | true if ALUA (Asymmetric Logical Unit Access) is enabled for initiator-group-name

Element definition: alua-setting-mismatch-initiator-info | [top]

> Information about an initiator that is a member of igroups that have an alua setting mismatch. Also detectes partner alua mismatch issues.

> Name | Range | Type | Description
> alua-is-enabled |  | boolean | true if ALUA (Asymmetric Logical Unit Access) is enabled for initiator-group-name.
> initiator-group-name |  | string | name of the initiator group name that the initiator belongs to.
> initiator-name |  | string | name of the initiator.

Element definition: clone-status-info | [top]

> Status of a cloning.

> Name | Range | Type | Description
> blocks-completed |  | integer | Number of blocks completed.
> blocks-total |  | integer | Total blocks to clone. The percentage complete is (completed * 100) / total
> path |  | string | LUN path being cloned.

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

> Fibre channel initiator that belongs to igroups on the local filer which have a different OS type than the initiator groups that this initiator belongs to on the partner filer. This conflict can produce unexpected host behavior and must be fixed.

> Name | Range | Type | Description
> initiator-local-os-type |  | string | OS type of the initiator on the local filer Possible values: aix, default, hpux, linux, netware, solaris, windows, mixed, vmware, openvms
> initiator-name |  | string | Fibre channel initiator nodename that has a different OS type on the local filer than the partner filer.
> initiator-partner-os-type |  | string | OS type of the initiator on the partner filer Possible values: aix, default, hpux, linux, netware, solaris, windows, mixed, vmware, openvms

Element definition: conflicting-luns-list | [top]

> List of the conflicting luns.

> Name | Range | Type | Description
> conflict-lun-path |  | string | Path of the lun that has the conflict. The format is: /vol// or /vol///

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

> lun mapping conflict.

> Name | Range | Type | Description
> initiator-name |  | string | Fibre channel initiator nodename that has a lun mapped from both filers in the cluster using the same LUN-id.
> lun-id |  | integer | lun-id used in mappings to the initiator from both filers in the cluster.

Element definition: fcp-down-hba-info | [top]

> Information about a down FCP HBA

> Name | Range | Type | Description
> adapter |  | string | Which FC adapter.
> state |  | string | Description of HBAs state. Possible values: STARTUP UNINITIALIZED INITIALIZING FIRMWARE LINK NOT CONNECTED WAITING FOR LINK UP ONLINE LINK DISCONNECTED RESETTING OFFLINE OFFLINED BY USER/SYSTEM Unknown state

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 |  | string | OS type of the initiator group Possible values:aix, default, hpux, linux, solaris, windows, netware, unknown, vmware, openvms
> 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. Current supported types are "iscsi", "fcp" and unknown.
> 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 cluster failover operation. This value is optional and is only returned for FCP initiator groups on clustered filers.
> initiator-group-vsa-enabled |  | boolean | Boolean value to indicate if this initiator group has VSA enabled or disabled.
> initiators |  | initiator-info[] | List of initiators belonging to this group.
> lun-id |  | 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.

Element definition: invalid-cfmode-setting-info | [top]

> local and partner cfmode settings

> Name | Range | Type | Description
> local-fcp-cfmode |  | string | cfmode setting of the local filer Possible values: dual_fabric, mixed, partner, standby, single_image
> partner-fcp-cfmode |  | string | cfmode setting of the partner filer Possible values: dual_fabric, mixed, partner, standby, single_image

Element definition: invalid-nodename-setting-info | [top]

> Information about different fcp nodenames

> Name | Range | Type | Description
> local-fcp-node-name |  | string | fcp nodename for the local filer
> partner-fcp-node-name |  | string | fcp nodename for the partner filer

Element definition: invalid-ostype-cfmode-setting-info | [top]

> Information about an invalid initiator group ostype and cfmode combination

> Name | Range | Type | Description
> initiator-group-name |  | string | Name of this initiator group.
> initiator-group-os-type |  | string | OS type of the initiator group Possible values:aix, default, hpux, linux, netware, solaris, windows, vmware, openvms

Element definition: invalid-use-partner-cfmode-setting-info | [top]

> Information about an invalid initiator group use_partner and cfmode

> Name | Range | Type | Description
> initiator-group-name |  | string | Name of this initiator group.
> is-use-partner-enabled |  | boolean | If true this initiator group's members are allowed to use the partner port.

Element definition: invalid-use-partner-ostype-setting-info | [top]

> Information about an invalid initiator group ostype and use_partner combination

> Name | Range | Type | Description
> initiator-group-name |  | string | Name of this initiator group.
> initiator-group-os-type |  | string | OS type of the initiator group Possible values:aix, default, hpux, linux, netware, solaris, windows, vmware, openvms
> is-use-partner-enabled |  | boolean | If true this initiator group's members are allowed to use the partner port.

Element definition: invalid-vsa-setting-info | [top]

> Information about an initiator group with an invalid Volume Set Addressing (VSA) setting for its ostype. Only 'hpux' initiator groups should have VSA enabled. All other initiator groups should have it disabled. Incorrect settings can cause hosts to not be able to access some or all of their luns.

> Name | Range | Type | Description
> initiator-group-name |  | string | Name of this initiator group.
> initiator-group-os-type |  | string | OS type of the initiator group Possible values:aix, default, hpux, linux, netware, solaris, windows, vmware, openvms
> is-vsa-enabled |  | boolean | If true this initiator groups's member will use VSA on the filer

Element definition: lun-clone-lists-info | [top]

> Details of the LUN clone in the specified snapshot.

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

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 |
> device-id | 0..2^31-1 | integer optional | SCSI Device Identifier for the LUN.
> 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 |  | string | Multiprotocol type of the LUN Possible values: aix, image, hpux, linux, netware, solaris, windows, vld, vmware, windows_gpt, windows_2008, openvms
> online |  | boolean | State of the LUN, ("online" or "offline"). "true" if online, "false" otherwise.
> path |  | string | Path of the LUN.
> read-only |  | boolean | "true" if the LUN is read only, "false" if read/write.
> serial-number |  | string | Serial number of the LUN. The serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters.
> share-state |  | string | Share state of the LUN, ("all", "none", read", or "write"). In the very rare case that the share state can not be determined, "unknown" is returned.
> size | 0..2^64-1 | integer | Size of this LUN in bytes in the active FS.
> size-used | 0..2^64-1 | integer | Number of bytes used by this LUN.
> staging |  | boolean | "true" if the LUN is a temporary staging LUN, "false" otherwise.
> uuid |  | string | Universal unique identifier (UUID) for 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.
> lun-id |  | integer | Logical Unit Number which the lun is mapped to for the requested initiator.
> path |  | string | Path of the Lun which is mapped to the requested initiator.

Element definition: lun-snap-usage-lun-info | [top]

> Details of the LUN backed by specified snapshot.

> Name | Range | Type | Description
> backing-store |  | string | Path of the LUN serving as the backing store.
> path |  | string | Path of the LUN.
> snapshot |  | string | Name of the snapshot in which the LUN exists.

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.
> last-zeroed | 0..2^64-1 | integer | Total number of seconds since the statistics for this lun were last zeroed.
> 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.
> 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: mixed-ostype-initiator-info | [top]

> Information about an initiator which is a member of initiator groups of differing ostypes. An initiator can only be a member of initiator groups which have the same ostype across all the initiator groups it is a member of.

> Name | Range | Type | Description
> initiator-group-name-1 |  | string | Name of this initiator group.
> initiator-group-name-2 |  | string | Name of this initiator group.
> initiator-group-os-type-1 |  | string | OS type of the initiator group Possible values:aix, default, hpux, linux, netware, solaris, windows, vmware, openvms
> initiator-group-os-type-2 |  | string | OS type of the initiator group Possible values:aix, default, hpux, linux, netware, solaris, windows, vmware, openvms
> initiator-name |  | string | Name of the initiator.

Element definition: mixed-vsa-initiator-info | [top]

> Information about an initiator which is a member of initiator groups with differing VSA settings. This will cause unexpected problems with the initiator.

> Name | Range | Type | Description
> initiator-group-name-1 |  | string | Name of this initiator group.
> initiator-group-name-2 |  | string | Name of this initiator group.
> initiator-name |  | string | Name of the initiator.
> is-vsa-enabled-1 |  | boolean | If true this initiator groups's member will use VSA on the filer
> is-vsa-enabled-2 |  | boolean | If true this initiator groups's member will use VSA on the filer

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

> Information about the persistent reservation

> Name | Range | Type | Description
> fcp-pr-nexus |  | fcp-pr-nexus-info optional | This is the I_T_Nexus info for an fcp type reservation.
> iscsi-pr-nexus |  | iscsi-pr-nexus-info 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 if it exist ("fcp" or "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. Valid reservation-type-codes are: "write exclusive" "exclusive access" "write exclusive registrants only" "exclusive access registrants only" "write exclusive all registrants" "exclusive access all registrants"

Element definition: fcp-pr-nexus-info | [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.

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-info | [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. 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.
> tpgroup-tag |  | integer | This is the target portal group tag (tpgtag) for the persistent reservation owner. An iSCSI initiator communicates to the target through a network portal. This portal must be a member of a target portal group (TPG). The target portal group tag (tpgtag) is the identifier used for the TPG.