|
APIs in Category: aggr |
Cluster-Mode API version 1.15 |
aggr-add |
These APIs allow for full manipulation of ONTAP aggregates, including those embedded in traditional volumes, and their structural components (plexes and RAID groups). |
| 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). Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. When the upgrade-64bit-mode input is provided to this API, the API produces a set of results in the background. These results are not available as output from aggr-add. Use the 'aggr-list-info' and 'volume-list-info' APIs to query the results of the 64-bit upgrade process on the aggregate and flexible volumes, respectively.
Input Name Range Type Description aggregate string
Name or UUID of the aggregate to which the disks will be added. See the synopsis for name/UUID format and restrictions. checksum-style string
optional
Specifies the checksum style for the disks to be added to an aggregate. This input is not allowed if a list of disks to use is specified through the "disks" parameter. The possible values: By default, disks with same checksum style as the aggregate are selected. Use this option to override that behavior and create a mixed checksum aggregate. "zoned" is not supported as one of the possible values as a mixed checksum aggregate can support only block and advanced_zoned checksum styles.
- "advanced_zoned" - advanced_zoned checksum (azcs),
- "block" - block.
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. disk-type string
optional
Type of disks to use : ATA, BSAS, EATA, FCAL, FSAS, LUN, SAS, SATA, SCSI, XATA, XSAS, or SSD. This option is required when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required. 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. 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. upgrade-64bit-mode string
optional
Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, aggr-add produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained by querying the 'aggr-list-info' and 'volume-list-info' APIs. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, "aggr-add" upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows "aggr-add" to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, "aggr-add" upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow "aggr-add" to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, "aggr-add" upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows "aggr-add" to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled. 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. upgrade-64bit-cookie integer
optional
The opaque cookie to uniquely identify this 64-bit upgrade transaction. This cookie can be compared against the cookie returned by aggr-list-info to ensure that the output produced by aggr-list-info corresponds to this 64-bit upgrade transaction. Range: [0..2^64-1].
Errno Description EINTERNALERROR EINVALIDINPUTERROR EAPIMISSINGARGUMENT EVOLUMEDOESNOTEXIST EVOLUMEDISKSIZEINVALID EVOLUMEDISKDUP EVOLUMEGSMINVALID EAGGR_TOO_LARGE EVOLUME_64BIT_UPGRADE_MODE_INVALID EOP_DISALLOWED_ON_AGGR_WITH_SPARSE_VOL EAGGR_WOULD_UPGRADE EVOLUME_64BIT_UPGRADE_PREQUAL_NOT_AVAIL EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL EVOLUME_IRON_NON_LOCAL_STATUS EVOLUME_64BIT_UPGRADE_ESTIMATE_IN_PROGRESS EAGGR_64BIT_UPGRADE_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC_OVERWRITE EAGGR_64BIT_UPGRADE_RESTRICTED EOP_DISALLOWED_ON_STRIPED_AGGR EAGGR_SIZE_LESS_THAN_16TB EVOLUME_64BIT_UPGRADE_DISALLOWED EDISK_TYPE_MISMATCH EONTAPI_EINVAL ECKSUMNOTKNOWN EMCS_NOT_ALLOWED_WITH_LUNS EAGGR_ZONED_NOT_ALLOWED_WITH_DISKS EVOLUME_ALREADY_64BIT ENOT_A_AZCS_DISK ENO_AZCS_DISKS
| aggr-check-spare-low | [top] |
Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.
Input Name Range Type Description node-name string
optional
Low spare condition checked on the requested node. When requested from Admin Vserver LIF and node name not specified, status for the cluster is returned. Output Name Range Type Description is-spare-low boolean
"true", if system has insufficient spare disk, "false" otherwise. When requested from Admin Vserver LIF, "true" is returned if one or more nodes in the cluster have spare low condition, "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. Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. 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 64_bit. Possible values: 32_bit, 64_bit checksum-style string
optional
Specifies the checksum style for the aggregate. This input is not allowed if a list of disks to use is specified through the "disks" parameter. The possible values:
- "advanced_zoned" - advanced_zoned checksum (azcs),
- "block" - block,
- "zoned" - zoned.
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, BSAS, EATA, FCAL, FSAS, LUN, SAS, SATA, SCSI, SSD, 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". nodes node-name[]
optional
Target node to create aggregate. If no node name is provided, aggregate will be created on the local node. If one node name is provided, aggregate(striped or not_striped based on the striping input) will be created on that node.When multiple nodes are specified, striped aggregate will be created across multiple nodes. 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. 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". "striped" value creates striped aggregate on node. 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. 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 EDISKTYPEWRONGFORSNAPLOCK EDISKTYPEWRONGFORVOL ENOT_A_AZCS_DISK ENO_AZCS_DISKS EONTAPI_EWORMNOCLOCK
| 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. From cluster interface only aggregates are supported and plexes are not supported.
Input Name Range Type Description aggregate string
Name of the existing aggregate or plex to be destroyed, using the following format: [/vol/] [ ] UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
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.
Input Name Range Type Description node-name string
Name of the node (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. The possible values:
- "zoned" - if all aggregates are Fixed VBN,
- "block" - if all aggregates are Block Appended,
- "mixed" - if aggregates are mixed (Fixed VBN, Block Appended and Advanced Zoned),
- "none" - if no aggregates have zoned or advanced_zoned checksum (azcs) or block checksums,
- "advanced_zoned" - if all aggregates have Advanced Zoned Checksum scheme.
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", "4096", "mixed", "none". "512" if all disks are 512 BPS, "520" if all disks are 520 BPS, "4096" if all disks are 4096 BPS, "mixed" if disks are mixed 512, 520 and 4096 BPS, "none" if no disks have 512 or 520 or 4096 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. Range : [0..2^31-1]. 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-iter | [top] |
Iterate over a list of aggrgate objects.
Input Name Range Type Description desired-attributes aggr-attributes
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query aggr-attributes
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the aggr object. All aggr objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list aggr-attributes[]
optional
The list of attributes of aggr objects. next-tag string
optional
Tag for the next call. Not present when there are no more aggr objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| 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]/] [ ] UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions. 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. 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/] [ ] UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions. 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.
Errno Description EINTERNALERROR EVOLUMEDOESNOTEXIST
| aggr-options-list-info | [top] |
Get the options that have been set for the specified aggregate. This API does not support listing options of striped 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 and restrictions. 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 or UUID of the aggregate to rename. See the synopsis for name/UUID format and restrictions. 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 or UUID of the aggregate to restrict. See the synopsis for name/UUID format and restrictions. 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-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. This API does not support modifying options of striped aggregate.
Input Name Range Type Description aggregate string
Name or UUID of the aggregate whose option to be set. See the synopsis for name/UUID format and restrictions. option-name string
Option name. Possible values:
- "free_space_realloc" (value: "on" | "off")
- Setting the option to "on" enables free space reallocation (continuous segment cleaning) on a block checksum aggregate.
- "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. This option is not supported when the request is sent to the Admin Vserver LIF.
- "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. This option is not supported when the request is sent to the Admin Vserver LIF.
- "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. This option is not supported when the request is sent to the Admin Vserver LIF.
- "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 or advanced_zoned checksum (azcs) 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_lost_write" (value: "on" | "off")
- Setting option to "off" disables RAID Lost Write protection on the aggregate. The default is "on". The user is cautioned that turning off the option may expose the filesystem(s) contained in the aggregate to data loss and data corruption. The option should not be disabled, unless directed to do so by support personnel.
- "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 only in maintenance mode and 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. This option is not supported when the request is sent to the Admin Vserver LIF.
- "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.
- "percent_snapshot_space" (value: < number >)
- Percentage of total blocks in the aggregate reserved for snapshots.
- "hybrid_enabled" (value: "true" | "false")
- Setting this option to "true" would mark the aggregate as hybrid_enabled. That means the aggregate can contain a mix of SSDs and HDDs(Hard Disk Drives, e.g., SAS, SATA, and/or FC). EAGGR_CANT_UNDO_HYBRID is returned when we are trying to set the option hybrid_enabled to false on an aggregate that already contains a mix of HDDs and SSDs. EAGGR_HYBRID is returned when we are trying to set option hybrid_enabled to true on an aggregate which is already hybrid. ESERVICENOTLICENSED is returned when the hybrid_aggregates license is not installed.
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 EAGGR_CANT_UNDO_HYBRID EAGGR_HYBRID ESERVICENOTLICENSED 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
| Element definition: aggr-attributes | [top] |
Attributes of an aggregate. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description aggr-64bit-upgrade-attributes aggr-64bit-upgrade-attributes
optional
Information related to 64-bit upgrade. After 64-bit upgrade completes, this information is no longer available. aggr-fs-attributes aggr-fs-attributes
optional
This field contains file system related information about the aggregate. This information will not be returned for a striped aggregate. aggr-inode-attributes aggr-inode-attributes
optional
This field contains inode related information about the aggregate. This information will not be returned for a striped aggregate. aggr-ownership-attributes aggr-ownership-attributes
optional
This field contains ownership related information about the aggregate. This information will not be returned for a striped aggregate. aggr-performance-attributes aggr-performance-attributes
optional
This field contains performance related informtaion about the aggregate. aggr-raid-attributes aggr-raid-attributes
optional
This field contains RAID specific information of the aggregate aggr-snaplock-attributes aggr-snaplock-attributes
optional
This field contains snaplock specific information of the aggregate aggr-snapmirror-attributes aggr-snapmirror-attributes
optional
This field contains snapMirror specific information of the aggregate This information will not be returned for a striped aggregate. aggr-snapshot-attributes aggr-snapshot-attributes
optional
This field contains snapshot specific information of the aggregate. This information will not be returned for a striped aggregate. aggr-space-attributes aggr-space-attributes
optional
This field contains space specific information of the aggregate aggr-striping-attributes aggr-striping-attributes
optional
This field contains striping specific information of the aggregate This information is returned only if aggregate is striped. aggr-volume-count-attributes aggr-volume-count-attributes
optional
This field contains various counts information of volume in the aggregate. aggr-wafliron-attributes aggr-wafliron-attributes
optional
This field contains wafliron specific information of the aggregate aggregate-name string
optional
Name of the aggregate. aggregate-uuid string
optional
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 nodes node-name[]
optional
List of node names. If aggregate-name is also specified, then the matching aggregate on given nodes is returned. If not, all aggregates on specified nodes are returned. If this element is omitted when the request is sent to the Admin Vserver LIF, then all matching aggregates in the cluster are returned. striping-type string
optional
Specifies the striping information about the aggregate. Possible values are "not_striped", "striped", and "unknown"
| 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: disk-info | [top] |
Information for each disk in the plex.
Name Range Type Description name string
Name of a member disk.
| Element definition: node-name | [top] |
The node's name
[none]
| 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: 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: aggr-64bit-upgrade-attributes | [top] |
Information related to 64-bit upgrade.
Name Range Type Description aggr-check-attributes aggr-check-attributes
optional
Information returned when upgrade-64bit-mode input in aggr-add API is "check". aggr-start-attributes aggr-start-attributes
optional
Information returned when upgrade-64bit-mode in aggr-add API is "grow_all", "grow_none", or "grow_reserved". aggr-status-attributes aggr-status-attributes
Status information related to 64-bit upgrade. This information includes whether the 64-bit upgrade is in progress.
| Element definition: aggr-fs-attributes | [top] |
File system specific information about the aggregate.
Name Range Type Description block-type string
optional
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" fsid [0..2^32-1] integer
optional
Aggregate's File System Identifier. type string
optional
The type of aggregate. Possible values: aggr, trad "aggr" (for aggregates that can contain flexible volumes) "trad" (for aggregates embedded in traditional volumes)
| Element definition: aggr-inode-attributes | [top] |
A structure returning inode-related information for a given aggregate's Active File System (AFS).
Name Range Type Description files-private-used [0..2^64-1] integer
optional
[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. files-total [0..2^64-1] integer
optional
[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. files-used [0..2^64-1] integer
optional
[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. inodefile-private-capacity [0..2^64-1] integer
optional
[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. inodefile-public-capacity [0..2^64-1] integer
optional
[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. maxfiles-available [0..2^64-1] integer
optional
[not settable, always] The count of the maximum number of user-visible files currently allowable on the referenced file system. maxfiles-possible [0..2^64-1] integer
optional
[not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. maxfiles-used [0..2^64-1] integer
optional
[not settable, online-only] The number of user-visible files currently in use on the referenced file system. percent-inode-used-capacity [0..100] integer
optional
[not settable, online-only] The percentage of disk space currently in use based on user-visible file (inode) count on the referenced file system.
| Element definition: aggr-ownership-attributes | [top] |
Ownership information about the aggregate.
Name Range Type Description home-id [0..2^32-1] 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' home-name string
optional
Name of the node to which this aggregate's disks have been administratively assigned. owner-id [0..2^32-1] integer
optional
NVRAM ID of node to which the aggregate ownership has been assigned. 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. owner-name string
optional
Name of node to which the aggregate ownership has been assigned. 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.
| Element definition: aggr-performance-attributes | [top] |
Performance specific attributes of the aggregate
Name Range Type Description free-space-realloc string
optional
Returns the free space reallocation state of the aggregate. Possible values : "on", "off"
| Element definition: aggr-raid-attributes | [top] |
RAID specific information of the aggregate
Name Range Type Description checksum-status string
optional
Checksum status. Possible values: "active", "initializing", "none", "off", "reinitialized", "reinitializing", "reverting", "unknown", "upgrading_phase1", "upgrading_phase2" This information will not be returned for a striped aggregate. checksum-style string
optional
Checksum style. The possible values:
- "advanced_zoned" - advanced_zoned checksum (azcs),
- "block" - block,
- "mixed" - mixed,
- "none" - none,
- "unknown" - unknown
- "wafl" - wafl,
- "zoned" - zoned.
disk-count [0..2^32-1] integer
optional
Number of disks in the aggregate. ha-policy string
optional
Aggregate's HA policy. Possible return values: "cfo", "sfo", "none" has-local-root boolean
optional
Whether the aggregate contains the local root volume. This information will not be returned for a striped aggregate. Default value is false. has-partner-root boolean
optional
Whether the aggregate contains the partner's root volume. This information will not be returned for a striped aggregate. Default value is false. is-checksum-enabled boolean
optional
Is checksumming enabled for the aggregate? Default value is false. is-hybrid boolean
optional
If true, aggregate currently contains both SSD and non-SSD RAID groups. is-hybrid-enabled boolean
optional
If true, aggregate is eligible to contain both SSD and non-SSD RAID groups. is-inconsistent boolean
optional
Whether or not the aggregate is inconsistent. Default value is false. mirror-status string
optional
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 . This information will not be returned for a striped aggregate. mount-state string
optional
[not settable, always] This field shows the volume's mount state. Possible values: "creating", "destroying", "frozen", "inconsistent", "iron_restricted", "mounting", "online", "quiescing", "quiesced", "reverted", "unmounted", "unmounting" This information will not be returned for a striped aggregate. plex-count [0..2^32-1] integer
optional
Number of plexes in the aggregate. This value tells us the size of the returned "plex" array. plexes plex-attributes[]
optional
List of plexes in the aggregate raid-lost-write-state string
optional
State of the RAID Lost Write feature for an aggregate. The possible values are:
- "aborted" - The RAID Lost Write scrub is no longer running and was aborted on all RAID groups in this aggregate, possibly due to an error.
- "illegal" - The aggregate contains RAID groups with RAID Lost Write disabled and other RAID groups with RAID Lost Write enabled. This is an invalid state.
- "inoperative" - The RAID Lost Write scrub is allowed on the aggregate, but it cannot start because the system-wide RAID Lost Write option "raid.lost_write.enable" is set to "off".
- "off" - RAID Lost Write protection and scrub are disabled on this aggregate.
- "on" - The aggregate is RAID Lost Write protected and that the RAID Lost Write scrub completed successfully on all RAID groups in this aggregate.
- "partial" - The RAID Lost Write scrub completed successfully on some of the RAID groups in this aggregate, but was aborted on at least one of the RAID groups.
- "unknown" - The RAID Lost Write scrub status could not be determined.
- "upgrade_partial" - The RAID Lost Write scrub is still in progress on some of the RAID groups in this aggregate and was aborted on at least one of the RAID groups.
- "upgrading" - The RAID Lost Write scrub is still not completed or not yet started on at least one of the RAID groups in this aggregate.
raid-size [0..2^32-1] integer
optional
Current RAID group size. This information will not be returned for a striped aggregate. raid-status string
optional
RAID status. Possible values: "copying", "degraded", "foreign", "growing", "initializing", "invalid", "ironing", "mirror degraded", "mirrored", "needs check", "normal", "noparity", "out-of-date", "partial", "reconstruct", "raid0", "raid4", "raid_dp", "mixed_raid_type", "resyncing", "SnapMirrored", "verifying". These values may appear by themselves or in combination separated by commas (e.g., "reconstruct,growing"). For striped aggregate, additional possible value is "various". An aggregate could be of only one of the following RAID types:
- "raid0" - All the raid groups in the aggregate are of type raid0,
- "raid4" - All the raid groups in the aggregate are of type raid4,
- "raid_dp" - All the raid groups in the aggregate are of type raid_dp,
- "mixed_raid_type" - This aggregate contains RAID groups of different RAID types (raid0, raid4, raid_dp).
state string
optional
Aggregate State Possible values:
- "creating" ,
- "destroying" ,
- "failed" ,
- "frozen" ,
- "inconsistent" ,
- "iron_restricted" ,
- "mounting" ,
- "online" ,
- "offline" ,
- "partial" ,
- "quiesced" ,
- "quiescing" ,
- "restricted" ,
- "reverted" ,
- "unknown" ,
- "unmounted" ,
- "unmounting"
| Element definition: aggr-snaplock-attributes | [top] |
Snaplock specific information of the aggregate
Name Range Type Description is-snaplock boolean
optional
Whether or not it's a SnapLock aggregate. 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"
| Element definition: aggr-snapmirror-attributes | [top] |
SnapMirror specific information of the aggregate
Name Range Type Description dp-snapmirror-destinations [0..500] integer
optional
When present, this field indicates the number of data protection (dp) snapmirror destination volumes. ls-snapmirror-destinations [0..500] integer
optional
When present, this field indicates the number of load sharing (ls) snapmirror destination volumes. mv-snapmirror-destinations [0..500] integer
optional
When present, this field indicates the number of move snapmirror destination volumes that are created for volume move operations.
| Element definition: aggr-snapshot-attributes | [top] |
A structure returning consolidated size-related information for all snapshots of the given aggregate.
Name Range Type Description files-total [0..2^64-1] integer
optional
[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. files-used [0..2^64-1] integer
optional
[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. maxfiles-available [0..2^64-1] integer
optional
[not settable, always] The count of the maximum number of files allowable on the referenced file system. maxfiles-possible [0..2^64-1] integer
optional
[not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. maxfiles-used [0..2^64-1] integer
optional
[not settable, online-only] The count of the number of files currently in use on the referenced file system. percent-inode-used-capacity [0..100] integer
optional
[not settable, online-only] The percentage of disk space currently in use based on file (inode) count on the referenced file system. percent-used-capacity [0..100] integer
optional
[not settable, online-only] The percentage of disk space currently in use on the referenced file system. size-available [0..2^64-1] 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. size-total [0..2^64-1] 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. size-used [0..2^64-1] 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.
| Element definition: aggr-space-attributes | [top] |
A structure returning space-related information for a given aggregate's Active File System (AFS).
Name Range Type Description hybrid-cache-size-total [0..2^64-1] integer
optional
[not settable, online-only] Total cache size (in bytes) in a hybrid aggregate. If the referenced aggregate is restricted or offline, or if it is not a hybrid aggregate, a value of 0 is returned. percent-used-capacity [0..100] integer
optional
[not settable, online-only] The percentage of disk space currently in use on the referenced file system. size-available [0..2^64-1] 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. size-total [0..2^64-1] 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 of 0 is returned. size-used [0..2^64-1] 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. total-reserved-space [0..2^64-1] integer
optional
[not settable, online-only] The total disk space in bytes that is reserved on the referenced file system. The reserved space is already counted in the used space, so this element can be used to see what portion of the used space represents space reserved for future use.
| Element definition: aggr-striping-attributes | [top] |
Striping specific information of a striped aggregate This information will not be returned for the not-striped aggregate.
Name Range Type Description member-count [0..2^32-1] integer
optional
Number of members in a striped aggregate.
| Element definition: aggr-volume-count-attributes | [top] |
WAFL volume count specific information of the aggregate
Name Range Type Description flexvol-count [0..500] integer
Number of volumes in the aggregate. flexvol-count-collective [0..500] integer
optional
Number of striped volume constituents in the aggregate which also represent a collective striped volume. This field is for internal use only. flexvol-count-not-online [0..500] integer
optional
When present, this field indicates the number of volumes that are not online (offline and restricted volumes). flexvol-count-quiesced [0..500] integer
optional
When present, this field indicates the number of quiesced online volumes. flexvol-count-striped [0..500] 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.
| Element definition: aggr-wafliron-attributes | [top] |
WAFL-iron specific information of the aggregate
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 [0..100] 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". state string
optional
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:
"aborting" - wafliron is aborting.
"checking_lost_blocks" - wafliron is checking for lost blocks.
"checking_lost_inodes" - wafliron is checking link counts.
"finishing" - wafliron is cleaning up.
"not_running" - wafliron is not running on this aggregate.
"scanning" - wafliron is scanning inodes, and/or fixing file system inconsistencies.
"starting" - wafliron is starting, allocating, and/or in the initial mounting phase.
"unknown" - wafliron state could not be determined.
| Element definition: aggr-check-attributes | [top] |
Information returned when upgrade-64bit-mode in aggr-add API is "check".
Name Range Type Description added-space integer
optional
The effective total space that would be added (in bytes) to the aggregate. This would not include the blocks used by the 64-bit upgrade of the aggregate and its contained flexible volumes. Range: [0..2^64-1]. check-last-errno integer
optional
The error code of the last attempt to check for space usage on the specific aggregate. This field is present only if a previous 64-bit upgrade check failed. Possible values: 0 - indicates success EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL Per-volume upgrade check results may be out of date if last-errno is not 0. cookie integer
optional
The opaque cookie to uniquely identify a 64-bit upgrade transaction previously triggered on the aggregate using aggr-add API. Range: [0..2^64-1]. is-space-estimate-complete boolean
optional
True if the space estimate has completed. Check "check-last-errno" to find out whether the space estimate was successful.
| Element definition: aggr-start-attributes | [top] |
Information returned when upgrade-64bit-mode in aggr-add API is "grow_all", "grow_none", or "grow_reserved".
Name Range Type Description min-space-for-upgrade integer
optional
The minimum additional disk space (in bytes) required to trigger 64-bit upgrade. This field is present when the specified disks do not have sufficient space to upgrade the aggregate and its contained flexible volumes to 64-bit. Range: [0..2^64-1]. start-last-errno integer
optional
The error code of the last attempt to start 64-bit upgrade on the specific aggregate. This field is present only if a previous 64-bit upgrade failed. Possible values include: EAGGR_64BIT_UPGRADE_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC_OVERWRITE EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL EVOLUME_64BIT_UPGRADE_PREQUAL_NOT_AVAIL
| Element definition: aggr-status-attributes | [top] |
Status information related to 64-bit upgrade. This information includes whether the 64-bit upgrade is in progress.
Name Range Type Description is-64-bit-upgrade-in-progress boolean
optional
True if the 64-bit upgrade is in progress.
| Element definition: plex-attributes | [top] |
Information about a plex.
Name Range Type Description is-online boolean
optional
"true" if the plex is online, "false" otherwise. is-resyncing boolean
optional
"true" if the plex is currently resyncing, "false" otherwise. plex-name string
optional
Name of the plex. raidgroups raidgroup-attributes[]
optional
List of all RAID groups in the plex. resyncing-percentage [0..100] integer
optional
If the plex is currently being resynced, then the completion percentage.
| Element definition: raidgroup-attributes | [top] |
Information about a raidgroup.
Name Range Type Description checksum-style string
optional
Checksum style for the RAID group. The possible values are: "none", "zoned", "block", "wafl", "unknown" or "advanced_zoned". is-recomputing-parity boolean
optional
"True" if the RAID group is currently recomputing parity. is-reconstructing boolean
optional
"true" if the RAID group is currently reconstructing. raidgroup-name string
optional
Name of the RAID group. recomputing-parity-percentage integer
optional
The percentage of parity recomputation completed, if is-recomputing-parity is true. Range : [0-100] reconstruction-percentage [0..100] integer
optional
If reconstruction is going on, then the completion percentage.