APIs in Category: resource-pool
API version 6.1

 
resource-pool-aggregate-add
resource-pool-aggregate-remove
resource-pool-create
resource-pool-destroy
resource-pool-iter
resource-pool-modify
A resource pool is a collection of aggregates used for storage service provisioning operations.

NetApp Manage ONTAP
 
resource-pool-aggregate-add [top]

Add an aggregate to a resource pool. An aggregate may only belong to a single resource pool.
Input Name Range Type Description
aggregate resource-key
The resource key of the aggregate to be added.
resource-pool resource-key
The resource key of the resource pool to which the aggregate is to be added.
 Errno  Description
 EOBJECTNOTFOUND
 E_AGGREGATE_ALREADY_IN_RESOURCE_POOL

 
resource-pool-aggregate-remove [top]
Remove an aggregate from a resource pool.
Input Name Range Type Description
aggregate resource-key
The resource key of the aggregate to be removed.
resource-pool resource-key
The resource key of the resource pool to which the aggregate belongs.
 Errno  Description
 EOBJECTNOTFOUND
 E_AGGREGATE_NOT_IN_RESOURCE_POOL

 
resource-pool-create [top]
Create a new resource pool.
Input Name Range Type Description
description string
optional
Description of the new resource pool.
name string
Name of the new resource pool.
 
Output Name Range Type Description
resource-key resource-key
The resource key of the newly created resource pool.
 Errno  Description
 EOBJECTEXISTS
 EINVALIDINPUT

 
resource-pool-destroy [top]
Destroy an existing resource pool.
Input Name Range Type Description
resource-pool resource-key
The resource key of the resource pool to be destroyed.
 Errno  Description
 EOBJECTNOTFOUND

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

 
resource-pool-modify [top]
Modify an existing resource pool.
Input Name Range Type Description
description string
optional
Modified description of the resource pool. Specifying this input with a blank value will remove the existing description from the resource pool.
name string
optional
Modified name of the resource pool. Must not match the name of any existing resource pools.
resource-pool resource-key
The resource key of the resource pool to be modified.
 Errno  Description
 EOBJECTNOTFOUND
 EINVALIDINPUT
 EOBJECTEXISTS

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

 
Element definition: resource-pool-info [top]
Information about a resource pool.
Name Range Type Description
aggregates resource-key[]
The collection of aggregates that belong to the resource pool.
capacity-available [0..2^63-1] integer
The combined available capacity of all the aggregates in the resource pool (in bytes).
capacity-total [0..2^63-1] integer
The combined total capacity of all the aggregates in the resource pool (in bytes).
capacity-used [0..2^63-1] integer
The combined used capacity of all the aggregates in the resource pool (in bytes).
description string
The description of the resource pool.
name string
The name of the resource pool.
resource-key resource-key
The resource key for the resource pool.

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