Module `netapp_ontap.resources.aggregate`

Retrieving storage aggregate information

The Storage Aggregate GET API retrieves all data aggregates in the cluster. System owned root aggregates are not included in the output. This API also supports specific queries, in addition to queries on aggregate body properties, which affect the output of the API. The parameters for these queries are "recommend" and "show_spares". Using the "recommend" query returns the list of aggregates that are recommended for creation in the cluster. The "show_spares" query returns a response outside of the records body, which includes the groups of usable spares in the cluster.
The collection GET returns the aggregate identifiers, UUID and name, and the node on which the aggregate resides. The instance GET, by default, returns all of the properties defined in the aggregates object, except advanced properties. The properties "space.footprint" and "space.block_storage.inactive_user_data" are considered advanced properties and only returned when requested using the "fields" query parameter. Performance "metric" and "statistics" for aggregates are also only returned when requested. The "statistics" property accounts for the cumulative raw values collected by ONTAP for an aggregate, while the "metric" property displays the incremental average for latency and incremental changes in IOPs and throughput over the last 15 seconds. Any external application can use the raw statistics to derive its own incremental performance metrics.

Creating storage aggregates

When the POST command is issued with no properties, the system evaluates the cluster attached storage, determines the optimal aggregate layout and configures the aggregates. This layout is completely controlled by the system. To view the recommended optimal layout rather than creating it, use the GET endpoint, setting the "recommend" query to 'true'. Alternatively, POST can be used with specific properties to create an aggregate as requested. At a minimum, the aggregate name, disk count, and the node where it should reside are required if any properties are provided.
When using POST with input properties, three properties are required. These are: - name - node.name or node.uuid - block_storage.primary.disk_count

Remaining properties are optional

The following properties can be specified in POST:

name - Name of the aggregate.
node.name and node.uuid - Node on which the aggregate will be created.
block_storage.primary.disk_count - Number of disks to be used to create the aggregate.
block_storage.mirror.enabled - Specifies whether or not the aggregate should be created using SyncMirror.
block_storage.primary.checksum_style - Checksum style of the disks to be use for the aggregate.
block_storage.primary.disk_class - Class of disks to be use to for the aggregate.
block_storage.primary.raid_size - Desired RAID size of the aggregate.
block_storage.primary.raid_type - Desired RAID type of the aggregate.
snaplock_type - SnapLock type to use on the aggregate.

Updating storage aggregates

The PATCH operation is used to modify properties of the aggregate. There are several properties that can be modified on an aggregate. Only one property can be modified for each PATCH request.
The list of patchable properties with a brief description for each is as follows:

name - This property can be changed to rename the aggregate.
node.name and node.uuid - Either property can be updated in order to relocate the aggregate to a different node in the cluster.
block_storage.mirror.enabled - This property can be changed from 'false' to 'true' in order to mirror the aggregate, if the system is capable of doing so.
block_storage.primary.disk_count - This property can be updated to increase the number of disks in an aggregate.
block_storage.primary.raid_size - This property can be updated to set the desired RAID size.
block_storage.primary.raid_type - This property can be updated to set the desired RAID type.
cloud_storage.tiering_fullness_threshold - This property can be updated to set the desired tiering fullness threshold if using FabricPool.

Deleting storage aggregates

If volumes exist on an aggregate, they must be deleted or moved before the aggregate can be deleted. See the /storage/volumes API for details on moving or deleting volumes.

Examples

Retrieving a list of aggregates from the cluster

The following example shows the response with a list of data aggregates in the cluster:

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(Aggregate.get_collection()))

Try it out

[
    Aggregate(
        {
            "name": "test1",
            "uuid": "19425837-f2fa-4a9f-8f01-712f626c983c",
            "node": {"uuid": "caf95bec-f801-11e8-8af9-005056bbe5c1", "name": "node-1"},
        }
    ),
    Aggregate(
        {
            "name": "test4",
            "uuid": "4a7e4139-ca7a-420b-9a11-3f040d2189fd",
            "node": {"uuid": "4046dda8-f802-11e8-8f6d-005056bb2030", "name": "node-2"},
        }
    ),
]

Retrieving a specific aggregate from the cluster

The following example shows the response of the requested aggregate. If there is no aggregate with the requested UUID, an error is returned.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Aggregate(uuid="870dd9f2-bdfa-4167-b692-57d1cec874d4")
    resource.get()
    print(resource)

Try it out

Aggregate(
    {
        "snaplock_type": "non_snaplock",
        "name": "test1",
        "uuid": "19425837-f2fa-4a9f-8f01-712f626c983c",
        "state": "online",
        "cloud_storage": {"attach_eligible": False},
        "block_storage": {
            "primary": {
                "checksum_style": "block",
                "raid_size": 24,
                "disk_class": "solid_state",
                "disk_count": 6,
                "raid_type": "raid_dp",
            },
            "mirror": {"state": "unmirrored", "enabled": False},
            "hybrid_cache": {"enabled": False},
        },
        "create_time": "2018-12-04T15:40:38-05:00",
        "space": {
            "efficiency": {
                "ratio": 6.908119720880661,
                "savings": 1408029,
                "logical_used": 1646350,
            },
            "cloud_storage": {"used": 0},
            "efficiency_without_snapshots": {
                "ratio": 1.0,
                "savings": 0,
                "logical_used": 737280,
            },
            "block_storage": {
                "full_threshold_percent": 98,
                "size": 235003904,
                "available": 191942656,
                "used": 43061248,
            },
        },
        "node": {"uuid": "caf95bec-f801-11e8-8af9-005056bbe5c1", "name": "node-1"},
        "data_encryption": {
            "software_encryption_enabled": False,
            "drive_protection_enabled": False,
        },
        "home_node": {"uuid": "caf95bec-f801-11e8-8af9-005056bbe5c1", "name": "node-1"},
    }
)

Retrieving statistics and metric for an aggregate

In this example, the API returns the "statistics" and "metric" properties for the aggregate requested.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Aggregate(uuid="538bf337-1b2c-11e8-bad0-005056b48388")
    resource.get(fields="statistics,metric")
    print(resource)

Try it out

Aggregate(
    {
        "name": "aggr4",
        "uuid": "538bf337-1b2c-11e8-bad0-005056b48388",
        "metric": {
            "latency": {"other": 123, "total": 124, "read": 149, "write": 230},
            "status": "ok",
            "duration": "PT15S",
            "iops": {"other": 11663, "total": 11682, "read": 1, "write": 17},
            "timestamp": "2019-07-08T22:16:45+00:00",
            "throughput": {
                "other": 193293789,
                "total": 194141115,
                "read": 7099,
                "write": 840226,
            },
        },
        "statistics": {
            "timestamp": "2019-07-08T22:17:09+00:00",
            "status": "ok",
            "latency_raw": {
                "other": 477201985,
                "total": 844628724,
                "read": 54072313,
                "write": 313354426,
            },
            "throughput_raw": {
                "other": 146185560064,
                "total": 213063348224,
                "read": 3106045952,
                "write": 63771742208,
            },
            "iops_raw": {
                "other": 1586535,
                "total": 3052032,
                "read": 328267,
                "write": 1137230,
            },
        },
    }
)

For more information and examples on viewing historical performance metrics for any given aggregate, see DOC /storage/aggregates/{uuid}/metrics

Retrieving a list of aggregates recommended for creation from the cluster

The following example shows the response with a list of recommended data aggregates in the cluster. Note: Each aggregate UUID provided in this response is not guaranteed to be the same UUID for the aggregate if it is created.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(Aggregate.get_collection(recommend=True, fields="*")))

Try it out

[
    Aggregate(
        {
            "name": "node_2_SSD_1",
            "uuid": "795bf7c2-fa4b-11e8-ba65-005056bbe5c1",
            "block_storage": {
                "primary": {
                    "disk_class": "solid_state",
                    "disk_count": 23,
                    "raid_type": "raid_dp",
                },
                "mirror": {"enabled": False},
                "hybrid_cache": {"enabled": False},
            },
            "space": {"block_storage": {"size": 1116180480}},
            "node": {"uuid": "4046dda8-f802-11e8-8f6d-005056bb2030", "name": "node-2"},
        }
    ),
    Aggregate(
        {
            "name": "node_1_SSD_1",
            "uuid": "795c0a15-fa4b-11e8-ba65-005056bbe5c1",
            "block_storage": {
                "primary": {
                    "disk_class": "solid_state",
                    "disk_count": 5,
                    "raid_type": "raid_dp",
                },
                "mirror": {"enabled": False},
                "hybrid_cache": {"enabled": False},
            },
            "space": {"block_storage": {"size": 176238592}},
            "node": {"uuid": "caf95bec-f801-11e8-8af9-005056bbe5c1", "name": "node-1"},
        }
    ),
]

Updating an aggregate in the cluster

The following example shows the workflow of adding disks to the aggregate.
Step 1: Check the current disk count on the aggregate.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Aggregate(uuid="19425837-f2fa-4a9f-8f01-712f626c983c")
    resource.get(fields="block_storage.primary.disk_count")
    print(resource)

Try it out

Aggregate(
    {
        "name": "test1",
        "uuid": "19425837-f2fa-4a9f-8f01-712f626c983c",
        "block_storage": {"primary": {"disk_count": 6}},
    }
)

Step 2: Update the aggregate with the new disk count in 'block_storage.primary.disk_count'. The response to PATCH is a job unless the request is invalid.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Aggregate(uuid="19425837-f2fa-4a9f-8f01-712f626c983c")
    resource.block_storage.primary.disk_count = 8
    resource.patch()

Step 3: Wait for the job to finish, then call GET to see the reflected change.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Aggregate

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Aggregate(uuid="19425837-f2fa-4a9f-8f01-712f626c983c")
    resource.get(fields="block_storage.primary.disk_count")
    print(resource)

Try it out

Aggregate(
    {
        "name": "test1",
        "uuid": "19425837-f2fa-4a9f-8f01-712f626c983c",
        "block_storage": {"primary": {"disk_count": 8}},
    }
)

Classes

class Aggregate (*args, **kwargs)

Allows interaction with Aggregate objects on the host

Initialize the instance of the resource.

Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

MyResource(name='foo').name == 'foo'

Args

*args: Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
**kwargs: each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

Ancestors

Resource

Static methods

def count_collection(*args, connection: HostConnection = None, **kwargs) -> int

Retrieves the collection of aggregates for the entire cluster.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See DOC Requesting specific fields to learn more. * metrics.* * space.block_storage.inactive_user_data * space.footprint * statistics.*

storage aggregate show

Learn more

DOC /storage/aggregates

Fetch a count of all objects of this type from the host.

This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

Returns

On success, returns an integer count of the objects of this type. On failure, returns -1.

Raises

NetAppRestError: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

def delete_collection(*args, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes the aggregate specified by the UUID. This request starts a job and returns a link to that job.

storage aggregate delete

Learn more

DOC /storage/aggregates

Delete all objects in a collection which match the given query.

All records on the host which match the query will be deleted.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
body: The body of the delete request. This could be a Resource instance or a dictionary object.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def find(*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves the collection of aggregates for the entire cluster.

Expensive properties

storage aggregate show

Learn more

DOC /storage/aggregates

Find an instance of an object on the host given a query.

The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host.

Returns

A Resource object containing the details of the object or None if no matches were found.

Raises

NetAppRestError: If the API call returned more than 1 matching resource.

def get_collection(*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> typing.Iterable

Retrieves the collection of aggregates for the entire cluster.

Expensive properties

storage aggregate show

Learn more

DOC /storage/aggregates

Fetch a list of all objects of this type from the host.

This is a lazy fetch, making API calls only as necessary when the result of this call is iterated over. For instance, if max_records is set to 5, then iterating over the collection causes an API call to be sent to the server once for every 5 records. If the client stops iterating before getting to the 6th record, then no additional API calls are made.

Args

*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
max_records: The maximum number of records to return per call
**kwargs: Any key/value pairs passed will be sent as query parameters to the host.

Returns

A list of Resource objects

Raises

NetAppRestError: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

def patch_collection(body: dict, *args, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates the aggregate specified by the UUID with the properties in the body. This request starts a job and returns a link to that job.

storage aggregate add-disks
storage aggregate mirror
storage aggregate modify
storage aggregate relocation start
storage aggregate rename

Learn more

DOC /storage/aggregates

Patch all objects in a collection which match the given query.

All records on the host which match the query will be patched with the provided body.

Args

body: A dictionary of name/value pairs to set on all matching members of the collection.
*args: Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to patch the collection of bars for a particular foo, the foo.name value should be passed.
connection: The HostConnection object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Methods

async def aggregate_create(links: dict = None, block_storage: dict = None, cloud_storage: dict = None, create_time: str = None, data_encryption: dict = None, dr_home_node: dict = None, home_node: dict = None, metric: dict = None, name: str = None, node: dict = None, snaplock_type: str = None, space: dict = None, state: str = None, statistics: dict = None, uuid: str = None) -> netapp_ontap.resource_table.ResourceTable

Create an instance of a Aggregate resource

Args

links
block_storage
cloud_storage
create_time: Timestamp of aggregate creation
data_encryption
dr_home_node
home_node
metric
name: Aggregate name
node
snaplock_type: SnapLock type
space
state: Operational state of the aggregate
statistics
uuid: Aggregate UUID

async def aggregate_delete(create_time: str = None, name: str = None, snaplock_type: str = None, state: str = None, uuid: str = None)

Delete an instance of a Aggregate resource

Args

create_time: Timestamp of aggregate creation
name: Aggregate name
snaplock_type: SnapLock type
state: Operational state of the aggregate
uuid: Aggregate UUID

async def aggregate_modify(create_time: str = None, query_create_time: str = None, name: str = None, query_name: str = None, snaplock_type: str = None, query_snaplock_type: str = None, state: str = None, query_state: str = None, uuid: str = None, query_uuid: str = None) -> netapp_ontap.resource_table.ResourceTable

Modify an instance of a Aggregate resource

Args

create_time: Timestamp of aggregate creation
query_create_time: Timestamp of aggregate creation
name: Aggregate name
query_name: Aggregate name
snaplock_type: SnapLock type
query_snaplock_type: SnapLock type
state: Operational state of the aggregate
query_state: Operational state of the aggregate
uuid: Aggregate UUID
query_uuid: Aggregate UUID

def aggregate_show(create_time: cliche.arg_types.choices.Choices.define.._Choices = None, name: cliche.arg_types.choices.Choices.define.._Choices = None, snaplock_type: cliche.arg_types.choices.Choices.define.._Choices = None, state: cliche.arg_types.choices.Choices.define.._Choices = None, uuid: cliche.arg_types.choices.Choices.define.._Choices = None, fields: typing.List = None) -> netapp_ontap.resource_table.ResourceTable

Fetch a list of Aggregate resources

Args

create_time: Timestamp of aggregate creation
name: Aggregate name
snaplock_type: SnapLock type
state: Operational state of the aggregate
uuid: Aggregate UUID

def delete(self, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse

Deletes the aggregate specified by the UUID. This request starts a job and returns a link to that job.

storage aggregate delete

Learn more

DOC /storage/aggregates

Send a deletion request to the host for this object.

Args

body: The body of the delete request. This could be a Resource instance or a dictionary object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs: Any key/value pairs passed will be sent as query parameters to the host.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def get(self, **kwargs) -> NetAppResponse

Retrieves the aggregate specified by the UUID. The recommend query cannot be used for this operation.

Expensive properties

storage aggregate show

Learn more

DOC /storage/aggregates

Fetch the details of the object from the host.

Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def patch(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse

Updates the aggregate specified by the UUID with the properties in the body. This request starts a job and returns a link to that job.

storage aggregate add-disks
storage aggregate mirror
storage aggregate modify
storage aggregate relocation start
storage aggregate rename

Learn more

DOC /storage/aggregates

Send the difference in the object's state to the host as a modification request.

Calculates the difference in the object's state since the last time we interacted with the host and sends this in the request body.

Args

hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs: Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

def post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse

Automatically creates aggregates based on an optimal layout recommended by the system. Alternatively, properties can be provided to create an aggregate according to the requested specification. This request starts a job and returns a link to that job.

Required properties

Properties are not required for this API. The following properties are only required if you want to specify properties for aggregate creation: * name - Name of the aggregate. * node.name or node.uuid - Node on which the aggregate will be created. * block_storage.primary.disk_count - Number of disks to be used to create the aggregate.

Default values

If not specified in POST, the following default values are assigned. The remaining unspecified properties will receive system dependent default values. * block_storage.mirror.enabled - false * snaplock_type - non_snaplock

storage aggregate auto-provision
storage aggregate create

Example:

POST /api/storage/aggregates {"node": {"name": "node1"}, "name": "test", "block_storage": {"primary": {"disk_count": "10"}}}

Learn more

DOC /storage/aggregates

Send this object to the host as a creation request.

Args

hydrate: If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
poll: If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
poll_interval: If the operation returns a job, this specifies how often to query the job for updates.
poll_timeout: If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
**kwargs: Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

NetAppRestError: If the API call returned a status code >= 400

Inherited members

Resource:
- from_dict
- get_collection_url
- get_connection
- instance_location
- path_keys
- poll
- set_connection
- to_dict

class AggregateSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)

The fields of the Aggregate object

Ancestors

netapp_ontap.resource.ResourceSchema
marshmallow.schema.Schema
marshmallow.base.SchemaABC

Class variables

block_storage GET POST PATCH

The block_storage field of the aggregate.

cloud_storage PATCH

The cloud_storage field of the aggregate.

create_time GET

Timestamp of aggregate creation

Example: 2018-01-01T16:00:00.000+0000

data_encryption GET POST PATCH

The data_encryption field of the aggregate.

dr_home_node GET POST PATCH

The dr_home_node field of the aggregate.

home_node GET POST PATCH

The home_node field of the aggregate.

links GET

The links field of the aggregate.

metric GET

The metric field of the aggregate.

name GET POST PATCH

Aggregate name

Example: node1_aggr_1

node GET POST PATCH

The node field of the aggregate.

snaplock_type GET POST

SnapLock type

Valid choices:

non_snaplock
compliance
enterprise

space GET POST PATCH

The space field of the aggregate.

state GET

Operational state of the aggregate

Valid choices:

online
onlining
offline
offlining
relocating
unmounted
restricted
inconsistent
failed
unknown

statistics GET

The statistics field of the aggregate.

uuid GET

Aggregate UUID

Retrieving storage aggregate information

Creating storage aggregates

Remaining properties are optional

Updating storage aggregates

Deleting storage aggregates

Examples

Retrieving a list of aggregates from the cluster

Retrieving a specific aggregate from the cluster

Retrieving statistics and metric for an aggregate

Retrieving a list of aggregates recommended for creation from the cluster

Updating an aggregate in the cluster

Classes

Args

Ancestors

Static methods

Expensive properties

Related ONTAP commands

Learn more

Args

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Expensive properties

Related ONTAP commands

Learn more

Args

Returns

Raises

Expensive properties

Related ONTAP commands

Learn more

Args

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Methods

Args

Args

Args

Args

Related ONTAP commands

Learn more

Args

Returns

Raises

Expensive properties

Related ONTAP commands

Learn more

Returns

Raises

Related ONTAP commands

Learn more

Args

Returns

Raises

Required properties

Default values

Related ONTAP commands

Example:

Learn more

Args

Returns

Raises

Inherited members

Ancestors

Class variables