APIs in Category: aggregate
API version 6.1

 
aggregate-iter

NetApp Manage ONTAP
 
aggregate-iter [top]

Iterate over existing aggregates.
Input Name Range Type Description
max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance.
resource-filter resource-key
optional
Resource by which to filter the result set. Any resource-filters specified in the first call must be included in subsequent calls. The allowed object types for this argument are:
  • cluster
  • cluster node
  • aggregate
If resource-filter identifies a aggregate, that single aggregate will be returned. If resource-filter resolves to more than one aggregate, all of them will be returned. If no resource-filter is provided, all aggregates will be listed.
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls.
 
Output Name Range Type Description
next-tag string
optional
Tag for the next call. Not present when there are no more objects to return.
num-records integer
The number of records returned in this call.
records aggregate-info[]
optional
The list of records.

 
Element definition: aggregate-info [top]
Information about a aggregate.
Name Range Type Description
aggr-volume-move-info aggr-volume-move-info
Provides information about volumes moving into and out of aggregates.
aggregate-name string
Full hierarchical name of the aggregate present in the output. The name is of the form, cluster-node:myaggr.
aggregate-resource-key resource-key
The resource key for this aggregate.
aggregate-size aggregate-size
Sizes of various parameters of the aggregate.
aggregate-space-status object-space-status
Space status of the aggregate. This indicates the fullness of the aggregate in terms of whether the percentage of used space with respect to total size of the aggregate has reached or crossed the fullness thresholds given in aggregate-nearly-full-threshold and aggregate-full-threshold.
aggregate-state string
State of aggregate. Following are the possible values:
  • offline
  • online
  • restricted
  • iron_restricted
  • creating
  • failed
  • partial
  • destroying
  • frozen
  • inconsistent
  • mounting
  • quiesced
  • quiescing
  • reverted
  • unmounted
  • unmounting
  • unknown
aggregate-status obj-status
Current status of the aggregate based on all events
block-type file-system-block-type
File system block type of the aggregate. The volumes on both the source and destination sides of a SnapMirror relationship must be of the same block type.
cluster-name string
Name of the cluster present in the output. The name is any simple name such as myhost.
cluster-node-name string
Name of controller. Always present in the output. The name is any simple name such as mynode.
cluster-node-resource-key resource-key
The resource key for the cluster-node. Always present in the output.
cluster-resource-key resource-key
The resource key for the cluster. Always present in the output.
compression-space-savings [0..2^63-1] integer
Space savings as a result of compression on the volume in bytes.
dedupe-space-savings [0..2^63-1] integer
Space savings as a result of deduplication on the aggregate's volumes in bytes.
has-local-root boolean
Specifies whether the aggregate contains the local root volume.
has-partner-root boolean
Specifies whether the aggregate contains the partner's root volume.
hybrid-cache-size-total [0..2^63-1] integer
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.
is-hybrid boolean
Specifies whether a given aggregate contains a mix of SSD and HHD RAID groups.
is-hybrid-enabled boolean
Specifies whether a given aggregate is eligible to contain both SSD and HDD RAID groups.
raid-type string
optional
Name of an allowed RAID type. Possible values are "raid0", "raid4", "raid_dp" and "mixed_raid_type".
time-to-full [0..31536000] integer
optional
Estimated amount of time left in seconds for the aggregate to become full. This is returned as empty when the estimated amount of time is more than a year. This can happen due to a very low or negative rate of consumption of space in the aggregate. Also, this field will not be returned if sufficient history data about a given aggregate is unavailable.

 
Element definition: resource-key [top]
A self-describing string identifier for a managed resource.
[none]

 
Element definition: aggr-volume-move-info [top]
Provides information about volumes moving into or out of aggregates.
Name Range Type Description
volume-in-count [0-2^31-1] integer
Total number of volumes currently being moved into this aggregate whose volume move state is in-progress or pause.
volume-in-total-size [0..2^63-1] integer
Sum of the sizes, in bytes, of all the volumes currently being moved into this aggregate whose volume move state is in-progress or pause.
volume-out-count [0-2^31-1] integer
Total number of volumes currently being moved out of this aggregate whose volume move state is in-progress or pause.
volume-out-total-size [0-2^63-1] integer
Sum of the sizes, in bytes, of all the volumes currently being moved out of this aggregate whose volume move state is in-progress or pause.

 
Element definition: aggregate-size [top]
Sizes of various parameters of an aggregate.
Name Range Type Description
daily-growth-rate [0..100] integer
optional
Percentage of change that occurs every 24 hours in the disk space used by the aggregate.
size-available [0..2^63-1] integer
Available bytes in the aggregate.
size-total [0..2^63-1] integer
Aggregate total size in bytes.
size-used [0..2^63-1] integer
Aggregate bytes used.
size-used-per-day [-2^44-1..2^44-1] integer
optional
The capacity (in bytes) used per day. This can be either positive or negative depending on the growth of used space in the aggregate. The information is based on the regression slope of the aggregate usage history data.
snapshot-reserve-avail [0..2^63-1] integer
optional
The available capacity (in bytes) in the Snapshot reserve for the aggregate. If snapshot-reserve-used is greater than snapshot-reserve-total, this value will be zero.
snapshot-reserve-total [0..2^63-1] integer
optional
Total capacity (in bytes) of Snapshot copy reserve.
snapshot-reserve-used [0..2^63-1] integer
optional
Total capacity (in bytes) for Snapshot data. The number can be greater than the Snapshot reserve size, but does not include any space used out of overwrite reserve.
space-total-committed [0..2^63-1] integer
optional
Total space committed in bytes.

 
Element definition: file-system-block-type [top]
Block Type of the file system. The volumes on both the source and destination sides of a SnapMirror relationship must be of the same block type. Volumes contained in a larger parent agregate may have a block-type of 64_bit. For upgraded systems it is possible that this value may be unknown until the system can determine the block-type. Possible values are:
  • 32_bit
  • 64_bit
  • unknown
[none]

 
Element definition: obj-status [top]
A status value which can be associated with an object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type.

Possible values are: 'normal', 'warning', 'error', 'critical'.

  • normal: An object has normal status when it is working within the thresholds specified.
  • warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption.
  • error: An object has error status when it does not cause any service disruption, but it may affect performance.
  • critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately.
In some contexts, it is important that severities are ordered (as above). For example, an alert might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.
[none]

 
Element definition: object-space-status [top]
Space status of the object. This indicates the fullness of the object in terms of whether the percentage of used space with respect to total size of the object has reached the fullness thresholds. Possible values:
  • ok - when the percentage of used space of the object is within the nearly full and full threshold of the object.
  • nearly_full - when the percentage of used space of the object is within the full threshold of the object but has reached or crossed the nearly full threshold.
  • full - when the percentage of used space of the object has reached or crossed the full threshold of the object.
[none]