APIs in Category: resourcepool | API version 3.6R2

resourcepool-add-member resourcepool-create resourcepool-destroy resourcepool-get-defaults resourcepool-list-info-iter-end resourcepool-list-info-iter-next resourcepool-list-info-iter-start resourcepool-member-list-info-iter-end resourcepool-member-list-info-iter-next resourcepool-member-list-info-iter-start resourcepool-modify resourcepool-remove-member resourcepool-update-free-space-status | A resource pool typically describes physical resources such as spare disks, aggregates or filers which are used for provisioning. When a resource pools contains a filer, all aggregates and spare disks on the filer are available for provisioning.

NetApp Manage ONTAP

resourcepool-add-member | [top]

> Add member -- 'filer' or 'aggregate' -- to an existing resource pool. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Write capability on the specified resource pool or DFM.Database.Read privilege on the object being added. ERESOURCEPOOLDOESNOTEXIST - When the specified resource pool does not exist. EOBJECTNOTFOUND - When the specified object of valid type to add is not found or object does not exist at all. EINVALIDMEMBERTYPE - When an aggregate to add contains traditional volume or it is aggregate snapshot. EOBJECTINANOTHERDYNAMICREFERENCE - When the specified object or its relative members, are already in another resource pool/storage set. Try again with move flag to move resources across resource pools. When used by storage set, you need to manually remove resource from storage set and add it to resource pool. EOBJECTEXISTSINRESOURCEPOOL - When the specified object already exists in the resource pool. EOBJECTAMBIGUOUS - When the specified object name is ambiguous to denote whether its filer or aggregate. Try again with fully qualified name or object id. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> member-name-or-id |  | string | Name or identifier of the member to add to the resource pool. Possible values are name/id of filer or aggregate. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].
> move-if-exists |  | boolean optional | If the object to add, or one or more of its contents, is already in a resource pool, this flag specifies that the object should be removed from the old dynamic reference and added to the resource pool. By default, the add operation fails if the object, or one of its contents, is already in a storage set or resource pool.
> resourcepool-name-or-id |  | string | Name or identifier of the resource pool to extend. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].

> Errno | Description
> EACCESSDENIED |  |
> ERESOURCEPOOLDOESNOTEXIST |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EINVALIDMEMBERTYPE |  |
> EOBJECTINANOTHERDYNAMICREFERENCE |  |
> EOBJECTEXISTSINRESOURCEPOOL |  |
> EDATABASEERROR |  |

resourcepool-create | [top]

> Create a new, empty resource pool. Error Conditions: EINVALIDINPUT - When invalid name specified. A valid name is non empty and constitutes at least one non-numeric character. ERESOURCEPOOLEXISTS - When the specified resource pool already exists. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> resourcepool |  | resourcepool-info | New information about a resource pool to modify. If any field is not specified, that field will not be changed. Name field should be specified and others are optional. If the optional fields are specified, they would be set during creation itself.
> Output Name | Range | Type | Description
> resourcepool-id |  | integer | Identifier of the new resource pool. Its a valid DFM object id. A valid DFM object id would be in the range of [1..2^31-1].

> Errno | Description
> EINVALIDINPUT |  |
> ERESOURCEPOOLEXISTS |  |
> EDATABASEERROR |  |

resourcepool-destroy | [top]

> Destroy a resource pool. If the resource pool is in use by a storage set or resource pool is not empty, the resource pool may only be destroyed by specifying the force flag. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Delete capability on the specified resource pool. ERESOURCEPOOLDOESNOTEXIST - When the specified resource pool does not exist. ERESOURCEPOOLNOTEMPTY - When the specified resource pool is not empty. Try again with force flag. ERESOURCEPOOLINUSE - When the specified resource pool is in use by a storage set. Try again with force flag. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> force |  | boolean optional | If specified, allows destroying a resource pool that has members or in use by storage set.
> resourcepool-name-or-id |  | string | Name or identifier of resource pool to destroy. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].

> Errno | Description
> EACCESSDENIED |  |
> ERESOURCEPOOLDOESNOTEXIST |  |
> ERESOURCEPOOLNOTEMPTY |  |
> ERESOURCEPOOLINUSE |  |
> EDATABASEERROR |  |

resourcepool-get-defaults | [top]

> Get the default values of attributes defined by this ZAPI set.

> Output Name | Range | Type | Description
> resourcepool-defaults |  | resourcepool-defaults | The default values of the attributes defined by this ZAPI.

resourcepool-list-info-iter-end | [top]

> Ends iteration of resource pools.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous resourcepool-list-info-iter-start.

> Errno | Description
> EINVALIDTAG |  |

resourcepool-list-info-iter-next | [top]

> Get next records in the iteration started by resourcepool-list-info-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of records to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous resourcepool-list-info-iter-start.
> Output Name | Range | Type | Description
> records |  | integer | The number of records actually returned. Value of 0 records indicates that end of records. Range: [1..2^31-1]
> resourcepools |  | resourcepool-info[] | List of resource pools.

> Errno | Description
> EINVALIDTAG |  |

resourcepool-list-info-iter-start | [top]

> Starts iteration to list resource pools. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Read capability on the specified resource pools. ERESOURCEPOOLDOESNOTEXIST - When the specified resource pool is not found in the database. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> include-free-space |  | boolean optional | If this value is true, then free space information will be included with each resource pool. If this value is false or not specified, then no free space information is included.
> object-name-or-id |  | obj-name-or-id optional | Name or identifier of a resource pool or group. If unspecified, all resource pools are listed.
> Output Name | Range | Type | Description
> records |  | integer | Number of items that have been saved for future retrieval with resourcepool-list-info-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to resourcepool-list-info-iter-next.

> Errno | Description
> EACCESSDENIED |  |
> EOBJECTNOTFOUND |  |
> EDATABASEERROR |  |

resourcepool-member-list-info-iter-end | [top]

> Ends iteration of resource pools.

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous resourcepool-member-list-info-iter-start.

> Errno | Description
> EINVALIDTAG |  |

resourcepool-member-list-info-iter-next | [top]

> Get next records in the iteration started by resourcepool-member-list-info-iter-start.

> Input Name | Range | Type | Description
> maximum |  | integer | The maximum number of records to retrieve. Range: [1..2^31-1]
> tag |  | string | Tag from a previous resourcepool-member-list-info-iter-start.
> Output Name | Range | Type | Description
> records |  | integer | The number of records actually returned. Value of 0 records indicates that end of records. Range: [1..2^31-1]
> resourcepool-members |  | resourcepool-member-info[] | List of the members of the resource pool.

> Errno | Description
> EINVALIDTAG |  |

resourcepool-member-list-info-iter-start | [top]

> Starts iteration to list members of specified resource pool. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Read capability on the specified resource pools. ERESOURCEPOOLDOESNOTEXIST - When the specified resource pool does not exist. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> include-indirect |  | boolean optional | If true, indirect members are included. By default they are not included.
> resourcepool-name-or-id |  | string | Name or identifier of the resource pool to query. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].
> Output Name | Range | Type | Description
> records |  | integer | Number of items that have been saved for future retrieval with resourcepool-member-list-info-iter-next. Range: [1..2^31-1]
> tag |  | string | Tag to be used in subsequent calls to resourcepool-member-list-info-iter-next.

> Errno | Description
> EACCESSDENIED |  |
> ERESOURCEPOOLDOESNOTEXIST |  |
> EDATABASEERROR |  |

resourcepool-modify | [top]

> Modify a resource pool's information. If modifying of one property fails, nothing will be changed. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Write capability on the specified resource pool. EINVALIDINPUT - When invalid input specified. A resourcepool-name should be non empty and constitutes at least one non-numeric character. The resourcepool-contact value should be email address which does not have any white space. ERESOURCEPOOLDOESNOTEXIST - When the specified resource pool does not exist. ERESOURCEPOOLEXISTS - Already a resource pool exists with the new name. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> resourcepool |  | resourcepool-info | New information about a resource pool to modify. If any field is not specified, that field will not be changed. If none of the optional parameters are specified, then this API does nothing.
> resourcepool-name-or-id |  | string | Name or identifier of the resource pool to modify. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].

> Errno | Description
> EACCESSDENIED |  |
> EINVALIDINPUT |  |
> ERESOURCEPOOLDOESNOTEXIST |  |
> ERESOURCEPOOLEXISTS |  |
> EDATABASEERROR |  |
> EINVALIDTIMEZONE |  |

resourcepool-remove-member | [top]

> Remove member -- filer or aggregate -- from a resource pool. Error Conditions: EACCESSDENIED - When the user does not have DFM.Database.Delete capability on the specified resource pool or DFM.Database.Read privilege on the object being removed. ERESOURCEPOOLDOESNOTEXIST - When the specified resource pool does not exist. EOBJECTNOTFOUND - When the specified object to remove not found. EOBJECTAMBIGUOUS - When the specified object name is ambiguous to denote whether its filer or aggregate. Try again with fully qualified name or object id. EOBJECTNOTINRESOURCEPOOL - When the specified object does not exist in the resource pool. EDATABASEERROR - On database error.

> Input Name | Range | Type | Description
> member-name-or-id |  | string | Name or identifier of member to remove from the resource pool. Possible values are name/id of filer or aggregate. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].
> resourcepool-name-or-id |  | string | Name or identifier of the resource pool to modify. It should be a valid DFM object name or object id. A valid DFM object name should contain at least one non-numeric character. A valid DFM object id should be in the range of [1..2^31-1].

> Errno | Description
> EACCESSDENIED |  |
> ERESOURCEPOOLDOESNOTEXIST |  |
> EOBJECTNOTFOUND |  |
> EOBJECTAMBIGUOUS |  |
> EOBJECTNOTINRESOURCEPOOL |  |
> EDATABASEERROR |  |

resourcepool-update-free-space-status | [top]

> Check the free space in the resource pool against the nearly-full and full thresholds and generate appropriate events for the resource pool.

> Input Name | Range | Type | Description
> resourcepool-name-or-id |  | obj-name-or-id | Name or identifier of resource pool

> Errno | Description
> EACCESSDENIED |  |
> ERESOURCEPOOLDOESNOTEXIST |  |
> EDATABASEERROR |  |

Element definition: obj-name-or-id | [top]

> Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI type string. An obj-name-or-id must contain between 1 and 64 characters, and must conform to one of the following formats: It must have the format of an obj-name, or It must be the decimal numeric string form of a positive integer whose value is in the range [1..2^31 - 1]. Elements of type obj-name-or-id are used only as inputs to ZAPIs. The value must match either the name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object type (e.g. data set, host, DP policy, etc.). Some ZAPIs allow the object to be one of several different types. If the format of an obj-name-or-id input element does not conform, or the value does not match the name or ID of an existing object, then generally the ZAPI documents that it fails with error code EOBJECTNOTFOUND. A ZAPI may return more specific error codes. In such cases, the ZAPI specification must document its behavior. If a ZAPI can accept a null value (e.g. reference to no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null value.

> [none]

Element definition: resourcepool-defaults | [top]

> The default values of the attributes defined by this ZAPI.

> Name | Range | Type | Description
> resourcepool-full-threshold |  | integer optional | The value (as an integer percentage) of the fullness threshold used to generate a "resource pool full" event for this resource pool. Setting threshold percentages higher than 100% allows an administrator to set it in such a way so that it never trigger these events. Range: [0..1000]
> resourcepool-nearly-full-threshold |  | integer optional | The value (as an integer percentage) of the fullness threshold used to generate a "resource pool nearly full" event for this resource pool. Setting threshold percentages higher than 100% allows an administrator to set it in such a way so that it never trigger these events. Range: [0..1000]

Element definition: resourcepool-info | [top]

> Information about a resource pool.

> Name | Range | Type | Description
> resourcepool-contact |  | email-address-list optional | Contact information for the resource pool, such as the owner's e-mail address. This is modifiable.
> resourcepool-description |  | string optional | Description of the resource pool, up to 255 characters long. This is modifiable.
> resourcepool-full-threshold |  | integer optional | The value (as an integer percentage) of the fullness threshold used to generate a "resource pool full" event for this resource pool. If the value specified is empty, then the resource pool setting is cleared and the value specified in resourcepool-get-defaults is used. Range: [0..1000]
> resourcepool-id |  | integer optional | Identifier of the resource pool. Its a valid DFM object id. A valid DFM object id would be in the range of [1..2^31-1]. Ignored for resourcepool-create and resourcepool-modify.
> resourcepool-kbytes-available |  | integer optional | Amount of Kbytes of storage available in this resource pool. This value only present if include-free-space was true. Ignored for resourcepool-create and resourcepool-modify. Range: [0..2^64-1].
> resourcepool-kbytes-total |  | integer optional | Total amount of Kbytes of storage in this resource pool. This value only present if include-free-space was true. Ignored for resourcepool-create and resourcepool-modify. Range: [0..2^64-1].
> resourcepool-kbytes-used |  | integer optional | Amount of Kbytes of storage used in this resource pool. This value only present if include-free-space was true. Ignored for resourcepool-create and resourcepool-modify. Range: [0..2^64-1].
> resourcepool-member-count |  | integer optional | The count of direct members added to the resource pool. This includes number of filers and aggregates added to the resource pool. Ignored for resourcepool-create and resourcepool-modify. Range: [0..2^31-1]
> resourcepool-name |  | string optional | Name of the resource pool. This is modifiable. This must be specified in resourcepool-create. Its a valid DFM object name. A valid DFM object name would contain at least one non-numeric character.
> resourcepool-nearly-full-threshold |  | integer optional | The value (as an integer percentage) of the fullness threshold used to generate a "resource pool nearly full" event for this resource pool. If the value specified is empty, then the resource pool setting is cleared and the value specified in resourcepool-get-defaults is used. Range: [0..1000]
> resourcepool-owner |  | string optional | Name of the owner of the resource pool, up to 255 characters long. This is modifiable.
> resourcepool-perf-status |  | obj-status optional | Current performance status of the resource pool. Ignored for resourcepool-create and resourcepool-modify.
> resourcepool-status |  | obj-status optional | Current status of the resource pool. Ignored for resourcepool-create and resourcepool-modify.
> resourcepool-timezone |  | string optional | Time zone in which this pool's storage is located. This is modifiable. An empty value means to use the system default (usually GMT). Currently valid time zones can be listed by timezone-list-info-iter.

Element definition: resourcepool-member-info | [top]

> Information about one member of a resource pool.

> Name | Range | Type | Description
> member-id |  | integer | Identifier of the member. Its a valid DFM object id. A valid DFM object id would be in the range of [1..2^31-1].
> member-name |  | string | Display name of the member. Its a valid DFM object name. A valid DFM object name would contain at least one non-numeric character.
> member-status |  | string | Current status of the member. Possible values are 'normal', 'information', 'unknown', 'warning', 'error', 'critical', 'emergency'.
> member-type |  | string | Type of the member. Possible values are 'filer' or 'aggregate'.

Element definition: email-address-list | [top]

> A list of email addresses. If more than one email address is specified, the addresses must be seperated by a ','. Spaces (and other white space) are not allowed, either between addresses or in them. Unprintable characters are also invalid. The list may contain up to 255 characters.

> [none]

Element definition: obj-status | [top]

> A status value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'error', 'critical', 'emergency'. unknown: An object has an unknown status when it transitions from one state to another. Ideally, an object will have this status briefly. For example, when an object has been added, but not yet discovered. normal: An object has normal status when it is working within the thresholds specified in DFM. information: The information events are normal occurrences on an object for which you can define alarms. unmanaged: An object is considered to be unmanaged when the login and password are not set for the appliance or agent. 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. emergency: An object is in emergency status when it stops performing unexpectedly and could lose data. In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.

> [none]