APIs in Category: aggr | API version 1.11

aggr-add aggr-check-spare-low aggr-create aggr-destroy aggr-get-filer-info aggr-get-root-name aggr-list-info aggr-mediascrub-list-info aggr-mirror aggr-offline aggr-online aggr-options-list-info aggr-rename aggr-restrict aggr-scrub-list-info aggr-scrub-resume aggr-scrub-start aggr-scrub-stop aggr-scrub-suspend aggr-set-option aggr-space-list-info aggr-split aggr-verify-list-info aggr-verify-resume aggr-verify-start aggr-verify-stop aggr-verify-suspend | These APIs allow for full manipulation of ONTAP aggregates, including those embedded in traditional volumes, and their structural components (plexes and RAID groups). Aggregates are identified in one of two ways: Name: The standard printable name for the aggregate, following standard ONTAP aggregate naming rules. UUID: A DCE UUID that is formatted as a 36-character string composed of 32 hexadecimal characters. A UUID is broken up into five groupings that are separated by dashes ('-'). The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is NOT used. Also note that this identifier is exactly equivalent to the standard RAID tree ID. Aggregate UUID values can always be determined by invoking 'aggr-list-info' with no parameters (which returns records for all of the node's aggregates) and examining the values of the returned 'uuid' fields. An aggregate identfier may also appear inside a pathname format, especially when specifying a plex or RAID group within the aggregate: [/vol/]<aggr_name_or_UUID>[<plexinfo>][<groupinfo>] where <plexinfo> is '/plex{0..n}' and <groupinfo> is '/rg{0..n}'. Examples include: my_aggr 9ff6e1ce-d57d-11db-be9c-000100000529 /vol/my_aggr /vol/9ff6e1ce-d57d-11db-be9c-000100000529 /vol/my_aggr/plex0 /vol/9ff6e1ce-d57d-11db-be9c-000100000529/plex0/rg3 Using UUID has the advantage of being able to access taken-over partner aggregates. An aggregate has an HA (High Availability) policy, which may be one of: 'cfo' (Controller Failover), or 'sfo' (Storage Failover), or 'none' (Not specified) Aggregates are allowed to have 'cfo' HA policy in both clustered and unclustered environments while having 'sfo' HA policy is restricted only to clustered environments. With 'cfo' HA policy, failover is strictly pairwise. When a node fails, its HA partner takes over its storage all at once. When the failed node reboots, its HA partner gives back its storage all at once. In clustered environments, with 'sfo' HA policy, failover may occur in a pairwise fashion much like 'cfo'. Additional differences from 'sfo' include that a node which takes over storage on behalf of another node temporarily takes ownership of that storage. Also, when giveback occurs, its storage is not returned all at once. Rather, the aggregates with 'cfo' HA policy, including root, and its disks are returned first, followed by the remaining storage for that node. An aggregate has a home owner, which is the node to which its disks have been administratively assigned.

NetApp Manage ONTAP

aggr-add | [top]

> Add disks to the specified aggregate, whether it is free-standing or embedded in a traditional volume. The disks to add are specified in the same way as for "aggr-create". Disks cannot be added to a mirrored aggregate if one or more of the plexes is offline. By the time the API returns, the disk(s) may not yet be completely added. Use 'aggr-list-info' to query the aggregate status to determine when it has finished growing due to the added disk(s).

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the aggregate to which the disks will be added.
> disk-count |  | integer optional | Number of disks to add, including the parity disks. The disks will come from the pool of spare disks. The smallest disks in this pool join the aggregate first, unless the "disk-size" argument is specified. Either the "disk-count" or "disks" argument must be specified. Range : [0..2^31-1].
> disk-size |  | integer optional | The individual disk size in 4KB blocks. For example, a disk-size of 131072000 represents a 500GB drive (131072000 * 4 * 1024 = 500 * 1024 * 1024 * 1024). Disks that are within approximately 20% of the specified size will be selected. If neither the "disk-size" nor the "disk-size-with-unit" argument is specified, existing groups are appended with disks that are the best match by size for the largest disk in the group. When starting new groups, disks that are the best match by size for the largest disk in the last raidgroup are selected first, then smaller disks, and finally larger disks. This "disk-size" option is ignored if a specific list of disks is specified through the "disks" parameter. Range : [0..2^31-1]. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
> disk-size-with-unit |  | string optional | This parameter accepts a disk size in the specified unit. It is a positive integer number followed by unit of "T", "G", "M" or "K". For example, these are accepted: 72G, 36G, 1T and 32M. But "72" will not be accepted. This "disk-size-with-unit" option is ignored if a specific list of disks is specified through the "disks" parameter. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
> disks |  | disk-info[] optional | Specific list of disks to add to the aggregate. If the aggregate is mirrored and a specific list of disks is supplied, another list ("mirror-disks") must also be supplied with the same number of disks. Either the "disks" or "disk-count" argument must be specified.
> force-spare-pool |  | boolean optional | Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option when it is set to "true".
> group-selection-mode |  | string optional | Specifies how DATA ONTAP adds the specified disks to raidgroups. Legitimate values are "last", "one", "new" or "all". group-selection-mode is an optional argument, and the behavior when it is not used is selected by value of raid-group. If raid-group is used, the behavior is the same as for group-selection-mode "one". If raid-group is not used, the behavior is the same as for group-selection-mode "last". The raid-group option must be used with group-selection-mode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by raid-group option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.
> mirror-disks |  | disk-info[] optional | Specific list of mirror disks needed to accompany the list in the "disks" parameter. This list must contain the same number of disks as specified in "disks".
> raid-group |  | string optional | Specifies the RAID group (for example rg0) to which the indicated disks are to be added. When a RAID group other than the last RAID group is specified, the aggregate can no longer be reverted to a version of ONTAP prior to 6.2. In such a case, the "force-spare-pool" option must be specified as well. By default, the filer fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.
> Output Name | Range | Type | Description
> bad-disks |  | disk-info[] optional | List of disks that were not added. This is only returned if there are bad disks.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EAPIMISSINGARGUMENT |  |
> EVOLUMEDOESNOTEXIST |  |
> EVOLUMEDISKSIZEINVALID |  |
> EVOLUMEDISKDUP |  |
> EVOLUMEGSMINVALID |  |

aggr-check-spare-low | [top]

> Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.

> Output Name | Range | Type | Description
> is-spare-low |  | boolean | "true", if system has insufficient spare disk, "false" otherwise.

aggr-create | [top]

> Create a new aggregate with the given name. Up to 200 aggregates can be created on each filer (including the aggregates that are "embedded" in traditional volumes, which must be created as a side effect of a traditional volume creation). The aggregate may not yet be operational immediately after the API returns. Use 'aggr-list-info' to query the status of the newly-created aggregate to determine when it is fully operational. NOTE: If ECANT_USE_ALL_DISKS is returned, then the requested aggregate was indeed created, just not with all the disks that were specified.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the aggregate to create. The aggregate name can contain letters, numbers, and the underscore character(_), but the first character must be a letter or underscore.
> block-type |  | string optional | The indirect block format that the aggregate can have. It can be either 32_bit or 64_bit. Specifying 64_bit allows creation of aggregates that can be larger than 16TB. The default is 32_bit. Possible values: 32_bit, 64_bit
> disk-count |  | integer optional | Number of disks to place into the aggregate, including parity disks. The disks in this newly- created aggregate come from the spare disk pool. The smallest disks in this pool join the aggregate first, unless the "disk-size" argument is provided. Either "disk-count" or "disks" must be supplied. Range [0..2^31-1].
> disk-size |  | integer optional | Disk size in 4KB blocks. Disks that are within 10% of the specified size will be selected for use in the aggregate. If neither "disk-size" nor "disk-size-with-unit" is specified, existing groups are appended with disks that are the best match for the largest disk in the group. When starting new groups, the smallest disks are selected first. This option is ignored if a specific list of disks to use is specified through the "disks" parameter. Range [0..2^31-1]. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
> disk-size-with-unit |  | string optional | Disk size in the specified unit. It is a positive integer number followed by unit of "T", "G", "M" or "K". This "disk-size-with-unit" option is ignored if a specific list of disks is specified through the "disks" parameter. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
> disk-type |  | string optional | Type of disks to use: ATA, EATA, FCAL, LUN, SAS, SATA, SCSI, XATA, or XSAS. This option is needed only when disks of different types are connected to the filer. It is not allowed if a list of disks to use is specified through the "disks" parameter. An aggregate can never be created using a mix of disks of different types.
> disks |  | disk-info[] optional | Specific list of disks to use for the new aggregate. If "mirrored" is set to true and a specific list of disks is supplied, the "mirror-disks" list with the same number of disks must also be supplied. Either "disk-count" or "disks" must be supplied.
> force-spare-pool |  | boolean optional | Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option when it is set to "true".
> ha-policy |  | ha-policy-type optional | Aggregate's HA policy. The only allowed values are "cfo" and "sfo". In clustered environments default value is 'sfo' if not specified. In unclustered environments, it is not allowed to specify this attribute as it is always be 'cfo' internally. EINVALIDINPUTERROR is returned if value is other than "cfo" and "sfo". EOP_CLUSTER_ATTR_DISALLOWED is returned if this attribute is used in unclustered environments.
> is-mirrored |  | boolean optional | Specifies that the new aggregate be mirrored (have two plexes). If set to "true", then the indicated disks will be split across the two plexes. By default, the new aggregate will not be mirrored.
> is-snaplock |  | boolean optional | Specifies the creation of a SnapLock aggregate. By default, is-snaplock is not specified. When is-snaplock is "true" the type of snaplock aggregate is determined in the following way - 1> If snaplock-type is set, create the type specified in snaplock-type (see snaplock-type for more details) 2> Otherwise, create a Snaplock enterprise aggregate if a Snaplock enterprise license has been installed. 3> Otherwise, create a Snaplock compliance aggregate. ESERVICENOTLICENSED is returned if the required Snaplock Compliance or Enterprise license is not installed. EONTAPI_EWORMNOCLOCK is returned if SnapLock Compliance Clock is not running. If you need to create a snaplock aggregate, the suggested method is to specify snaplock-type as "compliance" or "enterprise" and not specify is-snaplock at all. If you want to create a non-snaplock aggregate, the suggested method is to specify neither snaplock-type nor is-snaplock.
> language-code |  | string optional | Specifies the language to use for the new traditional volume via a language code. The default language is the one used by the filer's root volume. This option may be used only when creating a traditional volume, i.e. when "type" is "trad." For the full list of available language codes, see 'volume-create'.
> mirror-disks |  | disk-info[] optional | List of mirror disks to use. It must contain the same number of disks specified in "disks".
> raid-size |  | integer optional | Specifies the maximum number of disks in each RAID group in the aggregate. The maximum value for this parameter is 28. The default value is platform- dependent. The valid range of values is also platform-dependent, but never wider than [2..28].
> raid-type |  | string optional | Specifies the type of RAID groups to use in the new aggregate. Possible values: raid4, raid_dp. The default value is raid4 on most platforms.
> rpm |  | integer optional | Rotational speed of disks in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. This option is needed only when disks with different rotational speeds are connected to the filer. It is not allowed if a list of disks to use is specified through the "disks" parameter.
> snaplock-type |  | string optional | Specifies the type of Snaplock aggregate to be created. Possible values - "compliance" or "enterprise" ESERVICENOTLICENSED is returned if the necessary Snaplock compliance or enterprise license has not been installed. EINVALIDINPUT is returned if snaplock-type has an illegal value or if is-snaplock has been set to "false". EONTAPI_EWORMNOCLOCK is returned if SnapLock Compliance Clock is not running.
> striping |  | striping-type optional | Specifies the striping information about new aggregate. The only allowed values are "striped" and "not_striped". Default value is "not_striped". This attribute is not allowed in unclustered environments. EINVALIDINPUTERROR is returned if value is other than "striped" and "not_striped". EOP_CLUSTER_ATTR_DISALLOWED is returned if this attribute is used in unclustered environments. EOP_DISALLOWED_ON_CFO_AGGR is returned if this attribute is set to "striped" when aggregate being created with 'cfo' HA policy.
> type |  | string optional | The type of the aggregate. Possible values: aggr, trad. - "aggr" (aggregate contains flexible volumes) - "trad" (aggregate contains exactly one traditional volume) If not specified, the default is "aggr."
> Output Name | Range | Type | Description
> bad-disks |  | disk-info[] optional | List of disks that were not added. This is only returned if there are bad disks.

> Errno | Description
> EAPIMISSINGARGUMENT |  |
> ECANT_USE_ALL_DISKS |  |
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> ESERVICENOTLICENSED |  |
> EOP_CLUSTER_ATTR_DISALLOWED |  |
> EOP_DISALLOWED_ON_CFO_AGGR |  |
> EAGGR_TOO_LARGE |  |

aggr-destroy | [top]

> Destroys the specified aggregate or plex. If an aggregate is specified, all plexes in the aggregate are destroyed. If the aggregate is embedded in a traditional volume, then the entire traditional volume is destroyed. If a plex is specified, only that plex is destroyed, leaving an unmirrored aggregate containing the remaining plex. The disks in the destroyed object become spare disks. Only offline aggregates and plexes can be destroyed. Note: Offline aggregates will be destroyed even if they contain one or more flexible volumes, which should not typically be the case.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the existing aggregate or plex to be destroyed, using the following format: [/vol/][]
> force |  | boolean optional | When using "aggr-destroy" on a traditional volume, force the destruction of the volume even if a non-default vfiler has storage on it. Normally, the system will not destroy such a volume and will instead return EVOLUME_HAS_VFILER_STORAGE.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMENAMEINVALID |  |
> EVOLUMEOFFLINE |  |
> EVOLUME_HAS_VFILER_STORAGE |  |

aggr-get-filer-info | [top]

> Get information on what possibilities and parameters exist for aggregates on a given filer.

> Output Name | Range | Type | Description
> allowed-raidtypes |  | raidtype-info[] | List of RAID types allowed for aggregates on this filer.
> checksum-types |  | string | Checksum types supported by this filer. Possible values: zoned, block, mixed. "zoned" if all aggregates are Fixed VBN, "block" if all aggregates are Block Appended, "mixed" if aggregates are mixed (Fixed VBN and Block Appended), "none" if no aggregates have zoned or block checksums.
> default-raidtype |  | string | Default type of RAID used to protect against disk failure in aggregates on this filer. Possible values: raid0, raid4, raid_dp.
> disk-types |  | string | Type of disks supported by this filer. Possible values: 512, 520, mixed, none. "512" if all disks are 512 BPS, "520" if all disks 520 BPS, "mixed" if disks are mixed 512 and 520 BPS, "none" if no disks have 512 or 520 BPS.
> max-named-disks-per-request |  | integer | The maximum number of named disks which can be specified to 'aggr add', 'aggr create', or 'agg mirror' operation. Disk addition process may fail if the specified number of named disk is more than this limit. This value is the maximum number of disk entries which can be specified in 'disks' or 'mirror-disks' argument of 'aggr-create' and 'aggr-add' api.
> raidgroup-size |  | raidgroup-size-info[] | List of the RAID group sizing parameters for each RAID type supported on this filer.
> root-volume |  | string | Current root volume on the filer.
> snapshots-max |  | integer | Maximum number of snapshots available per aggregate on the filer. Range : [0..2^31-1].

> Errno | Description
> EINTERNALERROR |  |

aggr-get-root-name | [top]

> Return the name of the "root" volume on the filer.

> Output Name | Range | Type | Description
> root-volume |  | string | Name of the root volume for the filer.

> Vfiler-enabled
> Yes

aggr-list-info | [top]

> Get aggregate status.

> Input Name | Range | Type | Description
> aggregate |  | string optional | The aggregate name or UUID to get status for. See the synopsis for name/UUID format. If not supplied, get status of all aggregates owned by the local node.
> filter-attrs |  | filter-attrs-info optional | This input is used as a discriminant when status is required for one or more aggregates. This option will be ignored when an aggregate name is specified. If no argument is supplied, default value is NULL. If this is NULL or all of its elements are not supplied, then this filter has no effect and the behavior is the same as described in the 'aggregate' input description.
> verbose |  | boolean optional | If set to "true", detailed volume and plex information (including all the RAID group and disk information) is returned. If not supplied or set to "false", this extra information is not returned.
> Output Name | Range | Type | Description
> aggregates |  | aggr-info[] | List of aggregates and their status.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEDOESNOTEXIST |  |
> ELOWMEMORY |  |
> ENODENOTFOUND |  |

> Vfiler-enabled
> Yes

aggr-mediascrub-list-info | [top]

> Get the status of media scrubbing on the named aggregate, plex, or RAID group. Status includes percentage complete and the media scrub's status.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of an existing aggregate, plex, or RAID group, using the following format: [/vol/][][] If no name is given, then status is generated for all RAID groups currently being media-scrubbed.
> Output Name | Range | Type | Description
> mediascrub-details |  | mediascrub-detail-info[] | List of RAID groups and their media scrub status.

> Errno | Description
> EINTERNALERROR |  |

aggr-mirror | [top]

> Turns an unmirrored aggregate into a mirrored aggregate by adding a plex to it. The plex is either newly formed from disks chosen from a spare pool or, if the "victim-aggregate" option is specified, taken from another existing unmirrored aggregate. The named aggregate must currently be unmirrored. Disks may be specified explicitly using the "mirror-disks" list option in the same way as with the "aggr-create" and "aggr-add" commands. The number of disks indicated must match the number present in the existing aggregate. If disks are not specified explicitly, then disks are automatically selected to match those in the aggregate's existing plex.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the existing aggregate to be mirrored.
> force |  | boolean optional | Force the mirroring operation through, past the normal roadblocks that would otherwise cause it to be aborted. For example, disks in a plex are not normally permitted to span spare pools. Also, the victim cannot normally be accepted when it is owned by one or more vfilers. All these safety-driven behaviors are overridden when this option is set to "true".
> mirror-disks |  | disk-info[] optional | Specific list of mirror disks to add. This list must match the number of disks present on the existing aggregate. The specified disks are not permitted to span disk pools unless overridden with the "force-spare-pool" option.
> victim-aggregate |  | string optional | The "victim" aggregate to cannibalize in order to mirror the named aggregate. The "victim-aggregate" must have been previously joined with the aggregate to be mirrored and then split from it. The resulting mirrored aggregate is otherwise identical to the original aggregate before the operation. The "victim-aggregate" (and all its volumes) is effec- tively destroyed. "victim-aggregate" (and all its volumes) must be offline.
> Output Name | Range | Type | Description
> bad-disks |  | disk-info[] optional | List of disks that were not added. This is only returned if there are bad disks.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EVOLUMENAMEINVALID |  |
> EVOLUMEDISKSIZEINVALID |  |

aggr-offline | [top]

> Take the specified aggregate or plex offline. The operation takes effect before the API returns. Except in maintenance mode, the current root aggregate may not be taken offline. An aggregate marked to become the root aggregate cannot be taken offline. An aggregate containing one or more flexible volumes cannot be taken offline; its contained volumes must first be destroyed. A number of operations being performed on the given aggregate can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files in the aggregate opened by internal ONTAP processes. The command is aborted if any are found.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the existing aggregate or plex to offline, using the following format: [[/vol]/][] If the aggregate hosts any online volumes, then the offline request will fail unless the optional "unmount-volumes" argument (see below) appears and is set to TRUE. If we've been cleared to unmount any such online volumes hosted by the aggregate, the caller may also specify the number of seconds to wait should any of those volumes have active CIFS shares through the optional "cifs-delay-seconds" argument (see below). If a plex name is specified, the plex must be part of a mirrored aggregate, and both plexes must be online. Prior to offlining a plex, the system will flush all internally-buffered data associated with the plex and create a snapshot that is written out to both plexes. The snapshot allows for efficient resynchronization when the plex is subsequently brought back online.
> cifs-delay-seconds |  | integer optional | The number of seconds to wait before offlining any volumes that are hosted in the given aggregate that have active CIFS shares (if any). A value of 0 means that all such volumes are to be offlined immediately with no warning. CIFS users can lose data if they aren't given a chance to terminate applications gracefully. By default, "cifs-delay-seconds" is 0. NOTE: This argument may ONLY appear if the "unmount-volumes" argument (see above) also appears and is set to "TRUE".
> unmount-volumes |  | boolean optional | If set to "TRUE", this option specifies that all of the volumes hosted by the given aggregate are to be unmounted before the offline operation is executed. By default, the system will reject any attempt to offline an aggregate that hosts one or more online volumes.

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

aggr-online | [top]

> Bring the specified aggregate or plex online. This command takes effect immediately. All volumes on the aggregate are brought to whatever state they were in before the aggregate was restricted or taken offline. If there are CIFS shares associated with the any of the aggregate's volumes that were also onlined, they are enabled.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the existing aggregate or plex to online, using the following format: [/vol/][] If an aggregate is specified, it must currently be offline, restricted, or foreign (consisting of disks moved from another filer, and never having been brought online on the current filer). If the aggregate is foreign, it will be made native before being brought online on the current filer. Aggregates that aren't foreign are termed "native". If the aggregate is inconsistent but has not lost data, it is advisable to run WAFL_check or wafliron (or do a "snapmirror initialize" in case of a replica aggregate) prior to bringing it online. Bringing an inconsistent aggregate online increases the risk of further file system corruption. If the aggregate is inconsistent and has experienced possible loss of data, it can't be brought online unless WAFL_check or wafliron (or snapmirror initialize) is run on it. If a plex is specified, it must be part of an online mirrored aggregate. The system initiates resynchro- nization of the plex as part of online processing.
> keep-same-uuid |  | boolean optional | Keep existing foreign raidtree id (aggregate uuid). Normally when a foreign raidtree is onlined, the raidtree rtid (aggregate uuid) is changed to guarantee uniqueness. The behavior is overridden when this option is set "true." By default, "keep-same-uuid" is "false."

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEDOESNOTEXIST |  |

aggr-options-list-info | [top]

> Get the options that have been set for the specified aggregate.

> Input Name | Range | Type | Description
> aggregate |  | string | Name or UUID of the aggregate whose options to retrieve. See the synopsis for name/UUID format.
> Output Name | Range | Type | Description
> options |  | aggr-option-info[] | List of options set for this aggregate.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEDOESNOTEXIST |  |

aggr-rename | [top]

> Rename the specified aggregate.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the aggregate to rename.
> new-aggregate-name |  | string | The new name desired for the aggregate.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMENAMEINVALID |  |

aggr-restrict | [top]

> Restrict the specified aggregate. If the aggregate is embedded in a traditional volume, the entire traditional volume will be restricted. An aggregate with one or more flexible volumes cannot be restricted; all of its contained volumes must first be destroyed.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the aggregate to restrict.
> cifs-delay-seconds |  | integer optional | The number of seconds to wait before restricting any volumes that are hosted in the given aggregate that have active CIFS shares (if any). A value of 0 means that all such volumes are to be offlined immediately with no warning. CIFS users can lose data if they aren't given a chance to terminate applications gracefully. By default, "cifs-delay-seconds" is 0. NOTE: This argument may ONLY appear if the "unmount-volumes" argument (see above) also appears and is set to "TRUE".
> unmount-volumes |  | boolean optional | If set to "TRUE", this option specifies that all of the volumes hosted by the given aggregate are to be unmounted before the restrict operation is executed. By default, the system will reject any attempt to restrict an aggregate that hosts one or more online volumes.

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

aggr-scrub-list-info | [top]

> Get the status of parity scrubbing on the named aggregate, plex, or RAID group. Status includes percentage complete and the scrub's suspended status (if appropriate).

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of an existing aggregate, plex, or RAID group using the following format: [/vol/][][] If no name is given, then status is generated for all RAID groups currently being scrubbed.
> verbose |  | boolean optional | If set to "true", this operation will be verbose. If not supplied or set to false, normal output levels will be used.
> Output Name | Range | Type | Description
> scrub-details |  | scrub-detail-info[] | List of RAID groups and their scrub status.

> Errno | Description
> EINTERNALERROR |  |

aggr-scrub-resume | [top]

> Resume parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, then resume parity scrubbing on all RAID groups for which it has been suspended.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the existing aggregate, plex, or RAID group for which scrubbing is to resume, using the following format: [/vol/][][]

> Errno | Description
> EINTERNALERROR |  |

aggr-scrub-start | [top]

> Start parity scrubbing on the named aggregate, plex, or RAID group. Parity scrubbing compares the data disks to the parity disk in a RAID group, correcting the parity disk's contents as necessary. If no name is given, then parity scrubbing is started on all online aggregates. If an aggregate name is given, scrubbing is started on all RAID groups in the aggregate. If a plex name is given, scrubbing is started on all RAID groups contained in the plex. If a RAID group name is given, scrubbing is started only on that group. Use "aggr-scrub-list-info" to check scrubbing status.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the aggregate, plex, or RAID group to scrub, using the following format: [/vol/][][]

> Errno | Description
> EINTERNALERROR |  |

aggr-scrub-stop | [top]

> Stop parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, stop scrubbing on all RAID groups currently being scrubbed.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the aggregate, plex, or RAID group for which we are to stop parity scrubbing, using the following format: [/vol/][][]

> Errno | Description
> EINTERNALERROR |  |

aggr-scrub-suspend | [top]

> Suspend parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, suspend scrubbing on all RAID groups currently being scrubbed.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the aggregate, plex, or RAID group for which we are to suspend parity scrubbing using the following format: [/vol/][][]

> Errno | Description
> EINTERNALERROR |  |

aggr-set-option | [top]

> Set the specified option for the given aggregate to "option-value". The change remains effective even if the filer is rebooted. Some options have values that are numbers, and some have values that are "on" (also expressible as "yes", "true", or "1" ) or "off" (also expressible as "no", "false", or "0"). A mixture of uppercase and lowercase characters may be used when typing an option's value. Note that the "root" option is special in that it doesn't have a corresponding value.

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the aggregate for which we want to set an option.
> option-name |  | string | Option name. Possible values: "fs_size_fixed" (value: "on" | "off") Setting this option to "on" causes the file system to remain the same size (and not grow) when the mirror is broken on a SnapMirrored aggregate (which MUST be embedded in a traditional volume), or when an "aggr add" is performed on it. This option is automatically set to be "on" when an aggregate becomes SnapMirrored. It remains "on" after the "snapmirror break" command is issued for an aggregate embedded in a traditional volume. This option allows an embedded aggregate to be SnapMirrored back to the source without needing to add disks to the source aggregate. If the aggregate size is larger than the file system size, turning off this option forces the file system to grow to the size of the aggregate. "ha_policy" (value: "cfo" | "sfo") This option is used to change the HA policy of given aggregate and restricted to clustered environments. It is not allowed in unclustered environments. Also this option does not apply to traditional volume. HA policy can not be changed if: 1. aggregate is striped. 2. aggregate contains node volumes. 3. aggregate is root. 4. aggregate is partner aggregate during takeover i.e. when it is not home to local node. EOP_CLUSTER_ATTR_DISALLOWED is returned if this option is used in unclustered environments. EOP_DISALLOWED_ON_STRIPED_AGGR is returned if this option is used with striped aggregate. EOP_DISALLOWED_ON_AGGR_WITH_NODE_VOLS is returned if this option is used on aggregate which contains node volumes. EOP_DISALLOWED_ON_ROOT_AGGR is returned if this option is used on root aggregate. EOP_DISALLOWED_ON_NOT_HOME_AGGR is returned if this option is used on partner aggregate during takeover. "ignore_inconsistent" (value: "on" | "off") This command can only be used in maintenance mode. If this option is set to "on", then the root aggregate may be brought online when booting even if it is marked as inconsistent. The user is cautioned that bringing it online prior to running WAFL_check or wafliron may result in further file system inconsistency. "striping" (value: "striped" | "not_striped") This option sets the striping information of given aggregate. It is restricted to clustered environments and not allowed in unclustered environments. When set to true, it marks given aggregate as member of stripe. This option is not allowed if given aggregate is of 'cfo' HA policy. Also this option does not apply to traditional volume. EOP_CLUSTER_ATTR_DISALLOWED is returned if this option is used in unclustered environments. EOP_DISALLOWED_ON_CFO_AGGR is returned if given aggregate is of 'cfo' HA policy. "nosnap" (value: "on" | "off") Setting this option to "on" disables automatic snapshots on the aggregate. "raid_cv" (value: "on" | "off") Setting the option to "off" disables block checksum protection on the aggregate. The default is "on". The user is cautioned that turning off the option exposes the filesystems contained in the aggregate to inconsistency that could be caused by a misbehaving hardware component in the system. "raid_zoned" (value: "on" | "off") Setting the option to "off" disables zoned checksum protection on the aggregate. The default is "on". The user is cautioned that turning off the option exposes the filesystems contained in the aggregate to inconsistency that could be caused by a misbehaving hardware component in the system. "raidsize" (value: < number >>) The maximum size of a RAID group within the aggregate. Changing this option doesn't cause existing RAID groups to grow or shrink. Rather, it only affects whether more disks will be added to the last existing RAID group in the future, and how large new RAID groups will be. "raidtype" (value: "raid4" | "raid_dp" | "raid0") The type of RAID group used for this aggregate. The "raid4" setting provides one parity disk per RAID group, while "raid_dp" provides two. Changing this option immediately changes the RAID group type for all RAID groups in the aggregate. When upgrading RAID groups from "raid4" to "raid_dp", each RAID group begins a reconstruction onto a spare disk allocated for the second "dparity" parity disk. "resyncsnaptime" (value: < number >) Sets the mirror resynchronization snapshot frequency to be the given number of minutes. The default value is 60 (minutes). "root" (value: < none >) The specified aggregate is to become the root aggregate for the filer on the next reboot. This option can be used on only one aggregate at any given time. The existing root aggregate will become a non-root aggregate after the reboot. Until the system is rebooted, the original aggregate will continue to show root as an option, and the new root aggregate will show diskroot as an option. In general, the aggregate that has the diskroot option is the one that becomes the root aggregate following the next reboot. The only way to remove the root status of an aggregate is to set it on another aggregate. In clustered environments, this option is not allowed with aggregates with 'sfo' HA policy as root has to be an aggregate with 'cfo' HA policy. EOP_DISALLOWED_ON_SFO_AGGR is returned if given aggregate is of 'sfo' HA policy. "snapmirrored" (value : "off") If SnapMirror is enabled, the filer auto- matically sets this option to "on". Set this option to "off" with the "snapmirror" command if SnapMirror should no longer be used to update the mirror. After setting this option to "off", the mirror becomes a regular writable aggregate, and all its volumes are restored to whatever state they were last in. Note that it is not possible to set this option directly through this interface. Rather, it is automatically changed as a side effect of running the appropriate "snapmirror" commands. "snapshot_autodelete" (value: "on" | "off") Setting this option to "off" disables automatic snapshot deletion on the aggregate. "thorough_scrub" (value: "on" | "off") Setting the option to "on" enables thorough scrub on a block checksum aggregate. That means that a scrub will initialize any zeroed checksum entries that it finds. If there are any checksum entries to be initialized, scrub will run slower than normal.
> option-value |  | string | The value to set the named option. It may be the NULL/empty value only in the case of the "root" option.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDINPUTERROR |  |
> EOP_CLUSTER_ATTR_DISALLOWED |  |
> EOP_DISALLOWED_ON_CFO_AGGR |  |
> EOP_DISALLOWED_ON_SFO_AGGR |  |
> EOP_DISALLOWED_ON_STRIPED_AGGR |  |
> EOP_DISALLOWED_ON_AGGR_WITH_NODE_VOLS |  |
> EOP_DISALLOWED_ON_ROOT_AGGR |  |
> EOP_DISALLOWED_ON_NOT_HOME_AGGR |  |

aggr-space-list-info | [top]

> Show the space usage of the aggregate on a per flexible volume basis.

> Input Name | Range | Type | Description
> aggregate |  | string optional | The aggregate to get the space information for. If not specified the space information for all aggregates is obtained.
> Output Name | Range | Type | Description
> aggregates |  | aggr-space-info[] | Various counts describing space usage in the aggregate.

> Errno | Description
> EINTERNALERROR |  |

aggr-split | [top]

> Remove the specified plex from a mirrored aggregate and create a new unmirrored aggregate with the specified name that contains the plex. The original mirrored aggregate thus becomes unmirrored. The plex to be split from the original aggregate must be functional (not partial), but it can otherwise be inactive, resyncing, or out-of-date. "Aggr split" can therefore be used to gain access to a plex that isn't up to date with respect to its partner plex if its partner plex is currently failed. If the plex is offline at the time of the split, the resulting aggregate will be offline. Otherwise, the resulting aggregate will be in the same online/offline/restricted state as the original aggregate. A split mirror can be joined back together via the "victim-aggregate" option to "aggr-mirror".

> Input Name | Range | Type | Description
> aggregate |  | string | Name of the plex to split out of its aggregate, using the following format: [/vol/][][]
> new-aggr-name |  | string | Name of the new aggregate to create from the split plex.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMENAMEINVALID |  |
> EVOLUMEDOESNOTEXIST |  |

aggr-verify-list-info | [top]

> Get the status of RAID mirror verification on the named aggregate. Status includes percentage complete and whether it's currently suspended.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of an existing aggregate. If no name is given, then mirror verification status is generated for all aggregates currently being verified.
> Output Name | Range | Type | Description
> verify-details |  | verify-detail-info[] | List of aggregates and their mirror verification status.

> Errno | Description
> EINTERNALERROR |  |
> EVOLUMEDOESNOTEXIST |  |

aggr-verify-resume | [top]

> Resume RAID mirror verification on the named aggregate. If no name is given, then resume mirror verification on all aggregates that have been suspended.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the existing aggregate for which mirror verification is to resume.

> Errno | Description
> EINTERNALERROR |  |

aggr-verify-start | [top]

> Start RAID mirror verification on the named aggregate. Verification compares the data in both plexes of a mirrored aggregate. In the default case, any blocks that differ are logged and no changes are made. The fix-plex option is used to fix any mismatches. It specifies which plex to fix. If no name is given, then mirror verification is started on all online aggregates. Use the "aggr-verify-list-info" API to check mirror verification status. If the fix-plex option is used, then a name must be specified.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the mirrored aggregate to verify.
> fix-plex |  | integer optional | If provided, this specifies the plex to fix in case the two plexes do not match. The default is to log any discrepancies instead of fixing them.
> log-only |  | boolean optional | If provided, and if the value is "true", then simply log any discrepancies instead of fixing them. The default value is "true". If log-only is "false", then the fix-plex option must also be specified. If log-only is "true" and fix-plex is also specified, then the log-only option will be ignored.

> Errno | Description
> EINTERNALERROR |  |

aggr-verify-stop | [top]

> Stop RAID mirror verification on the named aggregate. If no name is given, stop mirror verification on all aggregates currently being verified.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the aggregate for which we are to stop mirror verification.

> Errno | Description
> EINTERNALERROR |  |

aggr-verify-suspend | [top]

> Suspend RAID mirror verification on the named aggregate. If no name is given, suspend mirror verification on all aggregates currently being verified.

> Input Name | Range | Type | Description
> aggregate |  | string optional | Name of the aggregate for which we are to suspend mirror verification.

> Errno | Description
> EINTERNALERROR |  |

Element definition: aggr-info | [top]

> Aggregate status information.

> Name | Range | Type | Description
> aggregate-space-details |  | aggregate-space-info optional | Contains all size-related information for the aggr and its set of snapshots.
> block-type |  | string | The indirect block format that the aggregate can have. It can be either 32_bit or 64_bit. A 64_bit value indicates that associated aggregates can be larger than 16TB. Possible values: 32_bit, 64_bit
> checksum-status |  | string | Checksum status. Possible values: "active", "off", "reverting", "none", "unknown", "initializing", "reinitializing", "reinitialized", "upgrading_phase1", "upgrading_phase2"
> checksum-style |  | string | Checksum style. The possible values: none, zoned, block, wafl, unknown.
> disk-count |  | integer | Number of disks in the aggregate. Range: [0..2^31-1].
> files-private-used |  | integer | Number of system (not user-visible) files used. Range: [0..2^64-1].
> files-total |  | integer | Total count of user-visible files. Range: [0..2^64-1].
> files-used |  | integer | Number of user-visible files used. Range: [0..2^64-1].
> fsid |  | integer optional | Aggregate's File System IDentifier. Range: [0..2^32-1]
> ha-policy |  | ha-policy-type optional | Aggregate's HA policy. Possible return values: "cfo", "sfo", "none"
> has-local-root |  | boolean | Whether the aggregate (or tradvol) contains the local root volume.
> has-partner-root |  | boolean | Whether the aggregate (or tradvol) contains the partner's root volume.
> home-id |  | integer optional | NVRAM ID of the node to which this aggregate's disks have been administratively assigned. This information derived from sanown information of aggregate's disk. See 'disk-sanown-detail-info' Range : [0..2^32-1].
> home-name |  | string optional | Name of the node to which this aggregate's disks have been administratively assigned.
> inodefile-private-capacity |  | integer | Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created. Range: [0..2^64-1].
> inodefile-public-capacity |  | integer | Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. Range: [0..2^64-1].
> is-checksum-enabled |  | boolean | Is checksumming enabled for the aggregate?
> is-inconsistent |  | boolean | Whether or not the aggregate is inconsistent.
> is-snaplock |  | boolean | Whether or not it's a SnapLock aggregate.
> mirror-status |  | string | Aggregate's mirror status. Possible values: invalid, uninitialized, needs CP count check, CP count check in progress, unmirrored, mirrored, mirror degraded, mirror resynchronizing, failed, limbo, and .
> mount-state |  | string optional | [not settable, always] This field shows the volume's mount state. Possible values: "unmounted", "online", "frozen", "destroying", "creating", "mounting", "unmounting", "inconsistent", "reverted", "quiescing", "quiesced", "iron_restricted"
> name |  | string | Aggregate name.
> owner-id |  | integer optional | NVRAM ID of node which currently owns this aggregate's disks. Normally, home-id matches owner-id. But these may be changed by SFO takeover to match the takeover node, and restored by SFO giveback to match home-id. CFO takeover and giveback do not affect owner-id. This information derived from sanown information of aggregate's disk. See 'disk-sanown-detail-info' Range : [0..2^32-1].
> owner-name |  | string optional | Name of node which currently owns this aggregate's disks. Normally, home-name matches owner-name. But these may be changed by SFO takeover to match the takeover node, and restored by SFO giveback to match home-name. CFO takeover and giveback do not affect owner-name.
> plex-count |  | integer | Number of plexes in the aggregate. This value tells us the size of the returned "plex" array. Range: [0..2^31-1].
> plexes |  | plex-info[] | List of plexes in the aggregate.
> raid-size |  | integer | Current RAID group size. Range : [0..2^31-1].
> raid-status |  | string | RAID status. Possible values: normal, verifying, SnapMirrored, copying, ironing, mirrored, resyncing, mirror degraded, invalid, needs check, initializing, growing, partial, noparity, degraded, reconstruct, out-of-date, foreign, raid4, raid0, raid_dp. These values may appear by themselves or in combination separated by commas (e.g., "reconstruct,growing").
> size-available |  | integer | Available bytes in the aggregate. Range: [0..2^64-1].
> size-percentage-used |  | integer optional | Percentage of aggregate used. This value is not returned if the aggregate is unusable (i.e., it's offline). Range : [0..100].
> size-total |  | integer | Aggregate total usable size in bytes, not including WAFL reserve and aggregate snapshot reserve. If the aggregate is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
> size-used |  | integer | Aggregate bytes used. This value is not returned if the aggregate is unusable (i.e., it's offline). Range: [0..2^64-1].
> snaplock-type |  | string optional | The type of the snaplock aggregate. It is present for snaplock aggrs only, i.e. aggrs for which is-snaplock is "true". Possible values - "compliance" or "enterprise"
> state |  | string | Aggregate state. The possible values: "creating", "destroying", "failed", "frozen", "inconsistent", "iron_restricted", "mounting", "offline", "online", "partial", "quiesced", "quiescing", "restricted", "reverted", "unknown", "unmounted", "unmounting".
> striping |  | striping-type optional | Specifies the striping information about the aggregate. Possible values are "striped", "not_striped" and "unknown" In unclustered environments, all aggregates are not striped. In clustered environments, aggregates can be either striped or not striped. When striping information is not known, "unknown" will be returned.
> type |  | string | The type of aggregate. Possible values: aggr, trad "aggr" (for aggregates that can contain flexible volumes) "trad" (for aggregates embedded in traditional volumes)
> uuid |  | string | Aggregate's Universal Unique IDentifier. UUIDs are 16-byte quantities that are typically displayed as having five hexadecimal fields separated by hyphens. For example: d2da3566-da53-11d7-a841-000100000529
> volume-count |  | integer | Number of volumes in the aggregate. Range: [0..500].
> volume-count-collective |  | integer optional | Number of striped volume constituents in the aggregate which also represent a collective striped volume. This field is for internal use only. Range: [0..500].
> volume-count-mirrors |  | mirror-count-info optional | Various counts information for mirror volumes in the aggregate. This information is returned only when the aggregate contains mirror volumes.
> volume-count-not-online |  | integer optional | When present, this field indicates the number of volumes that are not online (offline and restricted volumes). Range: [0..500]
> volume-count-quiesced |  | integer optional | When present, this field indicates the number of quiesced online volumes. Range: [0..500]
> volume-count-striped |  | integer optional | Number of striped volume constituents in the aggregate. These volumes are also reported in the full volume-count value. This field is for internal use only. Range: [0..500].
> volumes |  | contained-volume-info[] | List of volumes contained the aggregate.
> wafliron |  | aggr-wafliron-info optional | Information related to wafliron, the online WAFL file system check/repair tool. This information is returned only when wafliron specific information is available.

Element definition: aggr-option-info | [top]

> Option key and value. The possible values are described in the "aggr-set-option" API below.

> Name | Range | Type | Description
> name |  | string | Option key.
> value |  | string | Option value.

Element definition: aggr-space-info | [top]

> List of aggregates and their space usage information.

> Name | Range | Type | Description
> aggregate-name |  | string | Name of the aggregate.
> size-asis-used |  | integer | Space used by A-SIS metafiles. Range : [0..2^64-1]
> size-bssm-nvlog-used |  | integer optional | Space used by bi-directional Synchronous SnapMirror for NVLOG files. This element will be returned only if the value is not zero. Range : [0..2^64-1]
> size-free |  | integer | Total free space in the aggregate Range : [0..2^64-1]
> size-image-backup-used |  | integer | Space used by Image Backup metafiles. Range : [0..2^64-1]
> size-metadata |  | integer | Total space used by aggregates metadata. Range : [0..2^64-1]
> size-nominal |  | integer | Total space contained in the aggreate minus the wafl reserve space. Range : [0..2^64-1]
> size-snap-used |  | integer | Space used by aggregate snapshots. Range : [0..2^64-1]
> size-used |  | integer | The total used space in the aggregate except the space used by snapshots. Range : [0..2^64-1]
> size-volume-allocated |  | integer | Total space allocated to volumes in the aggregate. Range : [0..2^64-1]
> size-volume-used |  | integer | Total space used by volumes in the aggregate. Range : [0..2^64-1]
> volume-count |  | integer | Count of online virtual volumes in the aggregate. Range : [0..2^64-1]
> volumes |  | volume-space-info[] | List of flexible volumes and their allocated space information.

Element definition: disk-info | [top]

> Information for each disk in the plex.

> Name | Range | Type | Description
> name |  | string | Name of a member disk.

Element definition: filter-attrs-info | [top]

> List of filters based on attributes of an aggregate.

> Name | Range | Type | Description
> all |  | boolean optional | If true, returns all aggregates owned by the local node and also taken over by the local node. Default is false.
> is-cfo |  | boolean optional | If true, returns aggregates with 'cfo' HA policy which includes local and taken over aggregates. Default is false.
> is-local |  | boolean optional | If true, returns aggregates owned by the local node. It includes taken over aggregates with 'sfo' policy. Default is false.
> is-partner |  | boolean optional | If true, returns aggregates taken over by the local node but owned by the partner. Default is false.
> is-sfo |  | boolean optional | If true, returns aggregates with 'sfo' HA policy which includes local and taken over aggregates. Default is false.

Element definition: ha-policy-type | [top]

> HA Policy of aggregate. It can be controller failover or storage failover or unspecified. Allowed values are: "cfo": Controller FailOver "sfo": Storage FailOver "none": Unspecified

> [none]

Element definition: mediascrub-detail-info | [top]

> Information about media scrubbing.

> Name | Range | Type | Description
> percentage-complete |  | integer optional | Media scrubbing percentage complete.
> raid-group |  | string | Name of the RAID group.

Element definition: raidgroup-size-info | [top]

> Default, minimum and maximum raidgroup size for each RAID type supported on this filer.

> Name | Range | Type | Description
> default-size |  | integer | Default size of a RAID group of this type in aggregates. Range : [6..16].
> maximum-size |  | integer | Maximum size of a RAID group of this type in aggregates. Range : [6..28].
> minimum-size |  | integer | Minimum size of a RAID group of this type in aggregates. Possible values: 2, 3.
> raidtype |  | string | Name of the RAID type allowed on this filer. Possible values: raid0, raid4, raid_dp.

Element definition: raidtype-info | [top]

> RAID types allowed on this filer.

> Name | Range | Type | Description
> raidtype |  | string | Name of an allowed RAID type. Possible values: raid0, raid4, raid_dp.

Element definition: scrub-detail-info | [top]

> Scrubbing information.

> Name | Range | Type | Description
> is-suspended |  | boolean | Suspended state of the scrub on that RAID group.
> last-scrub-timestamp |  | integer optional | Time at which the last full scrub completed. If a scrub has never been performed, this value will not be returned. The time value is in seconds since January 1, 1970. Range : [0..2^31-1].
> percentage-complete |  | integer optional | Scrubbing percentage complete. I scrubbing is not active, this value will not be returned. Range : [0..100].
> raid-group |  | string | Name of the RAID group involved in the scrub.

Element definition: striping-type | [top]

> Striping information of aggregate. Allowed values are: "striped": Member of stripe. "not_striped": Not member of stripe. "unknown": Not known.

> [none]

Element definition: verify-detail-info | [top]

> Information about mirror verification.

> Name | Range | Type | Description
> is-suspended |  | boolean | Is mirror verification suspended for this aggregate?
> name |  | string | Name of the aggregate.
> percentage-complete |  | integer optional | Mirror verification percentage complete. If verification isn't active, this value won't be returned. Range: [0..100].

Element definition: aggr-wafliron-info | [top]

> Information related to wafliron, the online WAFL file system check/repair tool.

> Name | Range | Type | Description
> last-start-errno |  | integer optional | The error code of the last attempt to start wafliron on the specific aggregate or the traditional volume. This field is present only if 'wafliron start' was previously attempted.
> last-start-error-info |  | string optional | The error information of the last attempt to start wafliron on the specific aggregate or the traditional volume. This field is present only if 'wafliron start' was previously attempted.
> scan-percentage |  | integer optional | When present, this field indicates the percentage of blocks that have been scanned in the specified aggregate. This field is present only when wafliron is running and its state is "starting" or "scanning". Range: [0..100]
> state |  | string | When wafliron is run, it goes through different stages/states. This field indicates the current state of wafliron on the specified aggregate. Possible values are: "not_running" - wafliron is not running on this aggregate. "starting" - wafliron is starting, allocating, and/or in the initial mounting phase. "scanning" - wafliron is scanning inodes, and/or fixing file system inconsistencies. "checking_lost_blocks" - wafliron is checking for lost blocks. "checking_lost_inodes" - wafliron is checking link counts. "finishing" - wafliron is cleaning up. "aborting" - wafliron is aborting. "unknown" - wafliron state could not be determined.

Element definition: aggregate-space-info | [top]

> A set of two structures returning size-related information for a given aggregate and its set of snapshots.

> Name | Range | Type | Description
> aggregate-space |  | fs-space-info | [not settable, online-only] A structure returning size-related information for a given aggregate.
> snapshot-space |  | snapshot-space-info | [not settable, online-only] A structure returning size-related information for a set of snapshots of the given aggregate.

Element definition: contained-volume-info | [top]

> Information about a volume contained in the aggregate.

> Name | Range | Type | Description
> name |  | string | Volume name.

Element definition: mirror-count-info | [top]

> Various counts information for mirror volumes in the aggregate. This information is returned only when the aggregate contains mirror volumes. Currently, Vfiler owned mirror destination volumes are counted only if those volumes are online.

> Name | Range | Type | Description
> dp-qtree-snapmirror-destinations |  | integer optional | When present, this field indicates the number of data protection (dp) qtree snapmirror destination volumes. Range: [0..500]
> dp-snapmirror-destinations |  | integer optional | When present, this field indicates the number of data protection (dp) snapmirror destination volumes. Range: [0..500]
> ls-snapmirror-destinations |  | integer optional | When present, this field indicates the number of load sharing (ls) snapmirror destination volumes. Range: [0..500]
> move-snapmirror-destinations |  | integer optional | When present, this field indicates the number of move snapmirror destination volumes that are created for volume move operations. Range: [0..500]

Element definition: plex-info | [top]

> Information for a plex.

> Name | Range | Type | Description
> is-online |  | boolean | "true" if the plex is online, "false" otherwise.
> is-resyncing |  | boolean | "true" if the plex is currently resyncing, "false" otherwise.
> name |  | string | Plex name, e.g. /myvol/plex0
> raid-groups |  | raid-group-info[] optional | List of all RAID groups in the plex. This appears only if the "verbose" parameter above is set to "true".
> resyncing-percentage |  | integer optional | If the plex is currently being resynced, then the completion percentage. Range : [0..100].

Element definition: volume-space-info | [top]

> List of flexible volumes in the aggregate and their space usage.

> Name | Range | Type | Description
> guarantee |  | string | Type of guarantee option set on this volume. Possible values: none, file, volume
> volume-allocated |  | integer | Total space allocated for this volume in the aggregate. Range : [0..2^64-1]
> volume-name |  | string | Name of the volume
> volume-used |  | integer | Total space used by this volume. Range : [0..2^64-1]

Element definition: fs-space-info | [top]

> A structure returning size-related information for a given volume.

> Name | Range | Type | Description
> fs-files-private-used |  | integer | [not settable, online-only] Number of system (not user-visible) files (inodes) used. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> fs-files-total |  | integer | [settable, online-only] Total user-visible file (inode) count, i.e., maximum number of user-visible files (inodes) that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> fs-files-used |  | integer | [not settable, online-only] Number of user-visible files (inodes) used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> fs-inode-private-capacity |  | integer | [not settable, online-only] Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created. Range: [0 - 2^64-1]
> fs-inode-public-capacity |  | integer | [not settable, online-only] Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. Range: [0 - 2^64-1]
> fs-maxfiles-available |  | integer | [not settable, always] The count of the maximum number of user-visible files currently allowable on the referenced file system. Range: [0 - 2^64-1]
> fs-maxfiles-possible |  | integer | [not settable, always] The largest value to which the fs-maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. Range: [0 - 2^64-1] Range: [0 - 2^64-1]
> fs-maxfiles-used |  | integer | [not settable, online-only] The number of user-visible files currently in use on the referenced file system. Range: [0 - 2^64-1]
> fs-percent-inode-used-capacity |  | integer | [not settable, online-only] The percentage of disk space currently in use based on user-visible file (inode) count on the referenced file system. Range: [0...100]
> fs-percent-used-capacity |  | integer | [not settable, online-only] The percentage of disk space currently in use on the referenced file system. Range: [0...100]
> fs-sis-percent-saved |  | integer | [not settable, online-only] The percentage of disk space saved by eliminating the duplicated blocks on the referenced file system. Range: [0...100]
> fs-sis-saved-space |  | integer | [not settable, online-only] The total disk space in KBytes that is saved by storing only one copy of the duplicated blocks on the referenced file system. Range: [0 - 2^64-1]
> fs-sis-shared-space |  | integer | [not settable, online-only] The amount of data in KBytes that is shared by more than one instance on the referenced file system. Range: [0 - 2^64-1]
> fs-size-available |  | integer optional | [not settable, online-only] Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> fs-size-total |  | integer optional | [not settable, online-only] Total size (in bytes) of the referenced file system . If the referenced file system is restricted or offline, a value 0 is returned. Range: [0 - 2^64-1]
> fs-size-used |  | integer optional | [not settable, online-only] Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]

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

> Information for a particular RAID group.

> Name | Range | Type | Description
> disks |  | disk-info[] | List of disks in this plex.
> is-reconstructing |  | boolean | "true" if the RAID group is currently reconstructing.
> name |  | string | RAID group name.
> reconstruction-percentage |  | integer optional | If reconstruction is going on, the the completion percentage. Range : [0-100]

Element definition: snapshot-space-info | [top]

> A structure returning consolidated size-related information for all snapshots of the given volume.

> Name | Range | Type | Description
> snap-files-total |  | integer | [settable, online-only] Total file (inode) count, i.e., current maximum number of files (inodes) that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> snap-files-used |  | integer | [not settable, online-only] Number of files (inodes) used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> snap-maxfiles-available |  | integer | [not settable, always] The count of the maximum number of files allowable on the referenced file system. Range: [0 - 2^64-1]
> snap-maxfiles-possible |  | integer | [not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. Range: [0 - 2^64-1]
> snap-maxfiles-used |  | integer | [not settable, online-only] The count of the number of files currently in use on the referenced file system. Range: [0 - 2^64-1]
> snap-percent-inode-used-capacity |  | integer | [not settable, online-only] The percentage of disk space currently in use based on file (inode) count on the referenced file system. Range: [0...100]
> snap-percent-used-capacity |  | integer | [not settable, online-only] The percentage of disk space currently in use on the referenced file system. Range: [0...100]
> snap-sis-percent-saved |  | integer | [not settable, online-only] The percentage of disk space saved by eliminating the duplicated blocks on the referenced file system. Range: [0...100]
> snap-sis-saved-space |  | integer | [not settable, online-only] The total disk space in KBytes that is saved by storing only one copy of the duplicated blocks on the referenced file system. Range: [0 - 2^64-1]
> snap-sis-shared-space |  | integer | [not settable, online-only] The amount of data in KBytes that is shared by more than one instance on the referenced file system. Range: [0 - 2^64-1]
> snap-size-available |  | integer optional | [not settable, online-only] Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
> snap-size-total |  | integer optional | [not settable, online-only] Total size (in bytes) of the referenced file system. If the referenced file system is restricted or offline, a value 0 is returned. Range: [0 - 2^64-1]
> snap-size-used |  | integer optional | [not settable, online-only] Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]

Element definition: disk-info | [top]

> Information for each disk in the plex.

> Name | Range | Type | Description
> name |  | string | Name of a member disk.