Module netapp_ontap.resources.xc_aggregate
Copyright © 2022 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Classes
class XcAggregate (*args, **kwargs)
-
aggregate clone for cluster peer.
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
Static methods
def count_collection(*args, connection: HostConnection = None, **kwargs) -> int
-
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 find(*args, connection: HostConnection = None, **kwargs) -> Resource
-
Cross cluster GET 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) -> Iterable[Resource]
-
Cross cluster GET 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
objectsRaises
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.
Inherited members
class XcAggregateSchema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)
-
The fields of the XcAggregate object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
block_storage: AggregateBlockStorage GET POST PATCH
-
The block_storage field of the xc_aggregate.
-
cloud_storage: AggregateCloudStorage PATCH
-
The cloud_storage field of the xc_aggregate.
-
create_time: str GET
-
Timestamp of aggregate creation.
Example: 2018-01-01T12:00:00-04:00
-
data_encryption: AggregateDataEncryption GET POST PATCH
-
The data_encryption field of the xc_aggregate.
-
dr_home_node: DrNode GET
-
The dr_home_node field of the xc_aggregate.
-
home_node: Node GET POST PATCH
-
The home_node field of the xc_aggregate.
-
inactive_data_reporting: AggregateInactiveDataReporting GET POST PATCH
-
The inactive_data_reporting field of the xc_aggregate.
-
inode_attributes: AggregateInodeAttributes GET
-
The inode_attributes field of the xc_aggregate.
-
is_spare_low: bool GET
-
Specifies whether the aggregate is in a spares low condition on any of the RAID groups. This is an advanced property; there is an added cost to retrieving its value. The field is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter containing either footprint or **.
Example: false
-
links: SelfLink GET
-
The links field of the xc_aggregate.
-
metric: PerformanceMetric GET
-
The metric field of the xc_aggregate.
-
name: str GET POST PATCH
-
Aggregate name.
Example: node1_aggr_1
-
node: Node GET POST PATCH
-
The node field of the xc_aggregate.
-
recommendation_spares: List[AggregateSpare] GET POST PATCH
-
Information on the aggregate's remaining hot spare disks.
-
sidl_enabled: bool GET POST PATCH
-
Specifies whether or not SIDL is enabled on the aggregate.
-
snaplock_type: str GET POST
-
SnapLock type.
Valid choices:
- non_snaplock
- compliance
- enterprise
-
snapshot: AggregateSnapshot GET POST PATCH
-
The snapshot field of the xc_aggregate.
-
space: AggregateSpace GET POST PATCH
-
The space field of the xc_aggregate.
-
state: str GET POST PATCH
-
Operational state of the aggregate.
Valid choices:
- online
- onlining
- offline
- offlining
- relocating
- unmounted
- restricted
- inconsistent
- failed
- unknown
-
statistics: PerformanceMetricRaw GET
-
The statistics field of the xc_aggregate.
-
uuid: str GET
-
Aggregate UUID.
-
volume_count: Size GET
-
Number of volumes in the aggregate.