APIs in Category: disk
API version 6.1

 
disk-iter
disk-physical-summary-get

NetApp Manage ONTAP
 
disk-iter [top]

Iterate over disks.
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
  • disk
If resource-filter identifies a disk, that single disk will be returned. If resource-filter resolves to more than one disk, all of them will be returned. If no resource-filter is provided, all disks 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 disk-info[]
optional
The list of records.
 Errno  Description
 EINVALIDTAG

 
disk-physical-summary-get [top]
Retrieve data, parity, spare, and total space usage (by number of disks and bytes) for the specified aggregate, cluster, or cluster node. For a V-Series storage system, data LUNs, spare LUNs and total LUNs are also reported, if array LUNs exist. For an aggregate, spares and spare space is not reported.
Error Conditions:
  • EINVALIDINPUT - When invalid input specified.
  • EOBJECTNOTFOUND - When the object-name-or-id does not correspond to an appropriate object.
  • ENODISKSFOUND - When no disk information has been retrieved yet for the object-name-or-id.
Input Name Range Type Description
resource-filter resource-key
Resource key of an object to list the physical summary for. The allowed object types for this argument are:
  • cluster
  • cluster node
  • aggregate
 
Output Name Range Type Description
disk-info disk-physical-summary-disk-info
optional
Disk information. This item is returned for disk based systems.
lun-info disk-physical-summary-lun-info
optional
LUN information. This item is returned for V-Series systems.
 Errno  Description
 EINVALIDINPUT
 ENODISKSFOUND
 EOBJECTNOTFOUND

 
Element definition: disk-info [top]
Information about a disk.
Name Range Type Description
aggregate-name obj-full-name
optional
Name of the aggregate to which the disk belongs. When the aggregate the disk belongs to is not known or disk is a spare disk, aggregate-name will not be returned. The name is any simple name such as myaggr.
aggregate-resource-key resource-key
optional
Resource key of the aggregate to which the disk belongs. When the aggregate the disk belongs to is not known or disk is a spare disk, aggregate-resource-key will not be returned.
capacity-sectors [0..2^63-1] integer
Total number of disk sectors on this disk, given in units of 'bytes-per-sector'.
cluster-resource-key resource-key
Resource key of the cluster to which the disk belongs.
container-type container-type
Type of overlying disk container.
disk-name string
Name of the disk. Always present in the output. The name will look like "data disk 0b.18", "parity disk 0b.17", "dparity disk 0b.16" etc. Maximum length of 64 characters.
disk-path-info disk-path-info[]
Information about the paths of nodes attached to this disk.
disk-resource-key resource-key
Resource key of the disk. Always present in the output.
disk-size [0..2^63-1] integer
Disk size in bytes.
disk-type string
Type of the disk. Maximum length of 64 characters.
disk-uid string
optional
Identifier of the disk. This will be the Unique Identifier (UID) of the disk. When UID of a disk is not known, this field will not be returned. Maximum length of 90 characters. Format of disk UUID will look like: 2000000C:50A9022F:00000000:00000000:00000000:00000000: 00000000:00000000:00000000:00000000
effective-disk-type string
Effective type of the disk. Disks can report different disk-type, but the same effective-disk-type. Disks with the same effective-disk-type are compatible for use within the same aggregate.
failure-reason string
optional
The reason the disk is not in service.
is-permanently-failed boolean
Whether the disk is in the failed disk registry.
node-name obj-name
Name of host to which the disk belongs. Always present in the output. The name is any simple name such as myhost.
node-resource-key resource-key
Resource key of the host to which the disk belongs.
plex-name string
optional
Name of the plex to which the disk belongs. The name is any simple name such as plex0. When the plex the disk belongs to is not known or disk is a spare disk, plex-name will not be returned. Maximum length of 64 characters.
plex-resource-key resource-key
optional
Resource key of the plex to which the disk belongs. When the plex the disk belongs to is not known or disk is a spare disk, plex-resource-key will not be returned.
raidgroup-name string
optional
Name of the raidgroup to which the disk belongs. The name is any simple name such as rg0. When the raidgroup the disk belongs to is not known or disk is a spare disk, raidgroup-name will not be returned. Maximum length of 64 characters.
raidgroup-resource-key resource-key
optional
Resource key of the raidgroup to which the disk belongs. When the raidgroup the disk belongs to is not known or disk is a spare disk, raidgroup-resource-key will not be returned.

 
Element definition: disk-physical-summary-disk-info [top]
Summary Disk Information.
Name Range Type Description
data-disk-count [1..2^31-1] integer
Number of data disks.
parity-disk-count [1..2^31-1] integer
Number of parity disks.
parity-space [1..2^96-1] integer
Total parity disk space in bytes.
raw-space [1..2^96-1] integer
Total data disk space in bytes.
spare-disk-count [1..2^31-1] integer
optional
Number of spare disks. This is not returned if the specified object is an aggregate.
spare-space [1..2^96-1] integer
optional
Total spare disk space in bytes. This is not returned if the specified object is an aggregate.
total-disk-count [1..2^31-1] integer
Number of disks. This is the sum of the data disk, parity disk, and spare disk counts.
total-space [1..2^96-1] integer
Total disk space in bytes. This is the sum of the raw space, parity space, and spare space.

 
Element definition: disk-physical-summary-lun-info [top]
Summary LUN Information.
Name Range Type Description
data-lun-count [1..2^31-1] integer
Number of data LUNs.
raw-space [1..2^96-1] integer
Total data LUN space in bytes.
spare-lun-count [1..2^31-1] integer
optional
Number of spare LUNs. This is not returned if the specified object is an aggregate.
spare-space [1..2^96-1] integer
optional
Total spare LUN space in bytes. This is not returned if the specified object is an aggregate.
total-lun-count [1..2^31-1] integer
Number of LUNs. This is the sum of the data LUN and spare LUN counts.
total-space [1..2^96-1] integer
Total LUN space in bytes. This is the sum of the raw space and spare space.

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

 
Element definition: container-type [top]
Type of overlying disk container. Possible values:
  • "aggregate" - Container is an aggregate.
  • "broken" - Container is broken pool.
  • "labelmaint" - Container is online label maintenance list.
  • "maintenance" - Container is disk maintenance center.
  • "spare" - Container is spare pool.
  • "unassigned" - Disk ownership has not been assigned.
  • "unknown" - Container is currently unknown.
  • "volume" - Container is a traditional volume.
[none]

 
Element definition: disk-path-info [top]
Contains per path statistics, errors and other related data.
Name Range Type Description
disk-port string
optional
Disk port associated with this path. Possible values are "A" or "B". Omitted for non-disk target.
disk-port-name string
optional
Disk port name associated with this path. This has the form :, where is either "FC" for FibreChannel, or "SA" for SAS, and is either "A" or "B". Omitted for non-disk target.

Possible values:

  • "FC:A"
  • "FC:B"
  • "SA:A"
  • "SA:B"
node-name obj-name
Name of the controller with the initiator port for this path. Always present in the output. The name is any simple name such as myhost.
node-resource-key resource-key
Resource key of the controller with the initiator port for this path.

 
Element definition: obj-full-name [top]
Full name of an object. This typedef is an alias for the builtin ZAPI type string. An object full name conforms to all the rules of an obj-name, except that the full name may be up to 255 characters long.

Full names are created by concatenating an object name with any parent object names, so as to create a unique name for an object. The format of full names is as follows:

  • cluster full names are the either the fully-qualified domain name or the IP address of the cluster.
  • cluster-node full names are the either the fully-qualified domain name or the IP address of the cluster.
  • aggregate full names are the cluster-node name and the aggregate name, separated by a colon, e.g. cluster-node:aggr0.
  • volume full names are the vserver name and the volume name, separated by ":/", e.g. vserver:/volume. Note this does not include the "/vol" prefix. Volume and aggregate full names are distinguished by the presence of a forward slash after the colon.
  • qtree full names are the containing volume full name and the qtree name, separated by a slash, e.g. vserver:/volume/qtree. The data not contained by any qtree may be represented by "-", e.g. vserver:/volume/-.
  • lun full names are either a volume or qtree full name and the LUN path, separated by a slash, e.g. vserver:/volume/LUN or vserver:/volume/qtree/LUN.
  • initiator-group full names are vserver name and the initiator group name, separated by a colon, e.g. vserver:igroup.
  • export-policy full names are vserver name and the policy name, separated by a colon, e.g. vserver:policy-name.
  • lif full names are a cluster, cluster-node, or vserver name and the interface name, separated by a colon, e.g. cluster-name|cluster-node-name|vserver-name:lif.
  • port-set full names are the vserver name and the portset name, separated by a colon, e.g. vserver:portset.
  • fcp-target full names are the cluster-node name and the target name, separated by a colon, e.g. cluster-node:target.
For any object not listed above, the obj-name and obj-full-name are identical.
[none]

 
Element definition: obj-name [top]
Name of an object. This typedef is an alias for the built in ZAPI type string. An object name must conform to the following format:
  • It must contain between 1 and 64 characters.
  • It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
  • In some contexts, a name may be the empty string (""), which is interpreted as a null value, e.g., a reference to no object at all.
The behavior of a ZAPI when it encounters an error involving an obj-name input element depends on how the ZAPI uses the input element. Here are the general rules:
  • If the input name element is used to create a new object with the given name, or rename an existing object to that name, and the name does not conform to the above format, then the ZAPI fails with error code EINVALIDINPUT. Note that because EINVALIDINPUT is such a common error code, ZAPI specifications are not required to document cases when they may return it.
  • If the input name element is used to refer to an existing object with that name, and there is no object with that name, then the ZAPI fails with error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this error code.
A ZAPI may deviate from these general rules, for example, it may return more specific error codes. In such cases, the ZAPI specification must document its behavior.

If an input name element is used to refer to an existing object, then the ZAPI specification must specify which object type (e.g. cluster, vserver, volume etc.) is allowed. Some ZAPIs allow the object to be one of several different types. See the description of obj-full-name for examples of valid input formats.

Note that there is no requirement that all object names must be unique. However, the names for some specific types of objects are constrained such that no two objects of that type may have the same name.

[none]

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