APIs in Category: cluster |
API version 6.1 |
cluster-iter |
cluster-iter | [top] |
Iterate over clusters.
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: If resource-filter identifies a cluster, that single cluster will be returned. If resource-filter resolves to more than one cluster, all of them will be returned. If no resource-filter is provided, all clusters will be listed.
- cluster
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 cluster-info[]
optional
The list of records.
Errno Description EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND
cluster-node-iter | [top] |
Iterate over cluster nodes.
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: If resource-filter identifies a cluster node, that single cluster node will be returned. If resource-filter resolves to more than one cluster node, all of them will be returned. If no resource-filter is provided, all cluster nodes will be listed.
- cluster
- cluster node
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 cluster-node-info[]
optional
The list of records.
Errno Description EINVALIDINPUT EOBJECTNOTFOUND
Element definition: cluster-info | [top] |
Cluster's information.
Name Range Type Description cluster-address string
The cluster's primary IP address. cluster-diagnosis-status string
The diagnosis status of the cluster. Possible values: "ok", "ok-with-suppressed", "degraded" or "unreachable". cluster-name string
This is the name of the cluster. Length: [1..255] cluster-status obj-status
Current status of the host based on all events cluster-version string
This is the software release for a requested cluster. Length: [1..255] datasource-id obj-id
The id of the datasource used to collect information about this cluster. last-update-time timestamp
Start time of the last data collection. licenses license[]
List of licenses installed on the cluster. resource-key resource-key
The resource key for this cluster. serial-number string
The serial number of the cluster. Length: [1..64]
Element definition: cluster-node-info | [top] |
Information for a given node.
Name Range Type Description bytes-spare [0..2^63-1] integer
Spare raw capacity of the node in bytes. bytes-total [0..2^63-1] integer
Total raw capacity of the node in bytes. bytes-used [0..2^63-1] integer
Used raw capacity of the node in bytes. cluster-name obj-name
Name of the cluster where the node is present. cluster-node-aggr-size-info cluster-node-aggr-size
Information about aggregates on a node. cluster-node-disk-info cluster-node-disk-info
Information about disks on a node. cluster-node-down-timestamp timestamp
The downtime of the node. This is the number of seconds elapsed since midnight on January 1, 1970.(UTC) cluster-node-interconnect-info cluster-node-interconnect-info
Information about the failover interconnect on a node. cluster-node-name obj-name
This is the name of the node. Length: [1..255] cluster-node-port-count [1..2^31-1] integer
Number of physical ports (both ethernet and fibrechannel) in the node. cluster-node-resource-key resource-key
The resource key of the node. cluster-node-state string
State of the node. Possible values are: "online", "offline" cluster-node-status string
Current status of the node. cluster-node-uptime [0..2^32-1] integer
The total time, in seconds, that the node has been up. cluster-node-uuid string
The univerally unique identifier for the node. It is a 36-character string composed of 32 hexadecimal characters. For example, '542366ea-a024-11dd-9caa-7302e474c5ae'. cluster-resource-key resource-key
Resource-key of the cluster where the node is present. contact string
optional
The owner of the node. cpu-percent-busy [0..2^31-1] integer
optional
Percentage of the time that the node's CPU is busy. cpu-percent-busy-duration integer
optional
Time in seconds between measurements of CPU usage. env-failed-fan-status string
optional
Indication of the number of chassis fans which are not operating within the recommended RPM range. Possible values are: "normal", "one_failed", "many_failed" env-failed-power-supply-status string
optional
Indication of the number of failed power supply units. Possible values are: "normal", "one_failed", "many_failed" env-over-temperature-status string
optional
An indication of whether the hardware is currently operating outside of its recommended temperature range. The hardware will shutdown if the temperature exceeds critical thresholds. Possible values are: "normal", "hot" firmware-version string
optional
Firmware version of the controller. flash-cards flash-card-info[]
optional
Information about flash cards on a node. location string
optional
The physical location of the node as reported by Data ONTAP. model string
optional
The model of the node. nvram-battery-status string
optional
Status of the NVRAM battery. Possible values include:
- battery_ok
- battery_partially_discharged
- battery_fully_discharged
- battery_not_present
- battery_near_end_of_life
- battery_at_end_of_life
- battery_unknown
- battery_over_charged
- battery_fully_charged
nvram-id integer
optional
Vendor specific NVRAM identifier of the node. os-version string
Data ONTAP version running on the node. serial-number string
Serial number of the node. sfo-info sfo-info
Information about the storage failover configuration of this node.
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: cluster-node-aggr-size | [top] |
Information about the size of the aggregates in a node.
Name Range Type Description aggr-bytes-total [0..2^63-1] integer
Total capacity of the aggregates (in bytes) in a node. aggr-bytes-used [0..2^63-1] integer
Used capacity of the aggregates (in bytes) in a node.
Element definition: cluster-node-disk-info | [top] |
Collected information about disks on a node. Optional items will not be returned if the value is not known.
Name Range Type Description disk-failed-message string
optional
Provides information about a disk failure. failed-disk-count integer
optional
Number of failed disks on the node. reconstructing-disk-count integer
optional
Number of disks that are being reconstructing on the node. reconstructing-parity-disk-count integer
optional
Number of parity disks that are being reconstructed on the node. scrubbing-disk-count integer
optional
Number of disks that are being scrubbed on the node. verifying-parity-disk-count integer
optional
Number of parity disks that are being verified on the node.
Element definition: cluster-node-interconnect-info | [top] |
Collected information about a failover interconnect between two nodes.
Name Range Type Description interconnect-links string
optional
States of the individual interconnect links e.g. VIA Interconnect is down (link 0 down, link 1 down) VIA Interconnect is up (link 0 down, link 1 up) VIA Interconnect is up (link 0 up, link 1 down) interconnect-type string
optional
Type and vendor of the interconnect e.g. Infiniband (Mellanox Arbel) Infiniband (Mellanox Tavor) FCVI (Qlogic 2462) is-interconnect-up boolean
True, if storage clustering interconnect is up
Element definition: flash-card-info | [top] |
Collected information about a flash card on a node. Optional items will not be returned if the value is not known.
Name Range Type Description capacity [0..2^31-1] integer
Advertised capacity of the device, in gigabytes. firmware-revision string
Firmware revision of the FPGA on the flash device. model-name string
model name of the flash device in XXXXXX-XX format. percent-online [0..100] integer
Percentage of device capacity that is currently online. serial-number string
unique 10 digit serial number of the flash device. slot-number [1..255] integer
PCI-e slot number of the flash device. status string
The current status of the device. Possible values are "online", "offline_failed" and "offline_threshold".
Element definition: license | [top] |
License information of the Data ONTAP service.
Name Range Type Description description string
Short description of the license package. expiration-time timestamp
Time this license expires. This is the number of seconds elapsed since midnight on January 1, 1970.(UTC) owner-name string
Name of the owner (cluster, or cluster-node) Length: [1..255] owner-resource-key resource-key
Resource-key of the owner of this license. Can be resource-key of a cluster or cluster-node depending on owner-type. owner-type resource-type
Resource Type of cluster or cluster-node owning the license. package-name string
Name of the licensed Data ONTAP service.
Possible values:
- base
- nfs
- cifs
- iscsi
- fcp
- cdmi
- snaprestore
- snapmirror
- flexclone
- snapvault
- snaplock
- snapmanagersuite
- snapprotectapps
- v_storageattach
- snaplock_enterprise
- insight_balance
serial-number string
The serial number of the owner (cluster, or cluster-node). Length: [1..64]
Element definition: obj-id | [top] |
Identification number (ID) for an object. This typedef is an alias for the builtin ZAPI type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed to be 0, which is interpreted as a null value, e.g., a reference to no object at all. The ID for an object is always assigned by the system; the user is never allowed to assign an ID to an object. Therefore, an input element of type obj-id is always used to refer to an existing object by its ID. The ZAPI must specify the object's object type (e.g. cluster, volume, aggregate, etc.). Some ZAPIs allow the object to be one of several different types.
If the value of an obj-id input element does not match the ID of any existing object of the specified type or types, then typically the ZAPI fails with error code EOBJECTNOTFOUND. A ZAPI may deviate from this general rule, for example, it may return a more specific error code. In either case, the ZAPI specification must document its behavior.
[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: 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:
- 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.
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 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.
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: 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'.
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.
- 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.
[none]
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: sfo-info | [top] |
Information about the storage failover configuration of this node.
Name Range Type Description current-mode string
optional
Current HA mode giveback-state string
optional
Giveback state of the node. Possible values are:
- nothing_to_gb - No partner aggregates owned by local node.
- not_attempted_yet - Local node owns partner's aggregates and a giveback has not been attempted yet.
- giveback_in_progress - Giveback is in progress. Refer to current-giveback-module field to get the current module, the giveback process is in.
- giveback_failed_autogiveback_disabled- Previous giveback failed and auto giveback is disabled. Refer to current-giveback-module to get the module in which giveback process failed.
- giveback_failed_autogiveback_scheduled- Previous giveback failed and an auto giveback is scheduled. Refer to current-giveback-module to get the module in which giveback process failed. Refer time-until-autogiveback field to check time remaining before an auto giveback is initiated.
- previous_giveback_failed - Previous giveback failed. Refer to current-giveback-module to get the module in which giveback process failed.
- giveback_vetoed_no_di - Normal giveback not possible as disk inventory from partner has not yet been received.
- giveback_vetoed_missing_disks - Normal giveback not possible as the partner is missing some of its files system disks.
- autogiveback_scheduled - An auto giveback is scheduled Refer time-until-autogiveback field to check time remaining before an auto giveback is initiated.
- autogiveback_deferred - Auto giveback is deferred because the partner node was not ready to receive aggregates when the auto giveback timer expired. An auto giveback will be initiated as soon as the partner node is up and ready to receive aggregates.
- node_upgrade_in_progress - Local node owns partner's aggregates as part of node upgrade process.
- sfo_aggr_giveback_failed - Giveback of SFO aggregates failed. Call cf-aggregate-giveback-status API for more information regarding giveback failure.
- sfo_aggr_giveback_in_progress - Giveback of SFO aggregates is in progress. Call cf-aggregate-giveback-status API for more information regarding giveback status.
- partial_giveback - Local node owns partner's SFO aggregates.
- partner_spare_disks_giveback_pending- Local node owns partner's spare disks.
partner-name obj-name
The fully qualified domain name of the partner controller if this node is configured as part of an HA pair. Length: [1..255] partner-node-status string
Status of the partner node. This field is not returned if this node is not part of an HA pair. partner-resource-key resource-key
This is the resource key of the partner controller if this node is configured as part of an HA pair. sfo-state string
Storage failover configuration state. Possible values: "connected", "takeover_scheduled", "takeover_started", "takeover", "taken over", "takeover_failed", "giving_back", "giveback_partial_waiting", "giveback_partial_connected", "waiting_for_root_aggr", "waiting", "in_maintenance_mode", "pending_shutdown", "error". sfo-status string
Status of the SFO of the node. Possible values: "not_configured", "enabled", "disabled". takeover-by-partner-not-possible-reason string
optional
If takeover by the partner is not possible, list of one or more reasons why. takeover-failure-reason string
optional
Only returned if sfo-state is equal to takeover_failed. This is the reason for the takeover failure. takeover-of-partner-not-possible-reason string
optional
If the storage failover facility is disabled, list of one or more reasons why.
Element definition: timestamp | [top] |
Seconds since 1/1/1970 in UTC.
[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: 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:
- 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.
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 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.
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]
Element definition: resource-type | [top] |
A canonical type name for a managed resource. Includes both Data ONTAP and OnCommand resource types. Valid Data ONTAP resource types: Valid OnCommand resource types:
- aggregate
- cluster
- cluster_node
- disk
- export_policy
- export_rule
- fcp_lif
- fcp_port
- flash_device
- igroup
- iscsi_portal_group
- lun
- lun_mapping
- network_lif
- network_port
- ontap_job_schedule
- plex
- portset
- qtree
- raid_group
- routing_group
- service_processor
- sis_policy
- snap_mirror
- snapshot
- snapshot_policy
- snapshot_policy_schedule
- storage_class
- storage_shelf
- volume
- volume_move
- vserver
- management_station
- resource_pool
- service_workflow
- storage_service
- storage_service_connection
- storage_service_node
[none]