Module netapp_ontap.resources.cluster_space
Copyright © 2024 NetApp Inc. All rights reserved.
This file has been automatically generated based on the ONTAP REST API documentation.
Retrieves cluster-wide storage details across the different tiers. Storage details include storage efficiency, block storage and cloud storage information.
Example
Retrieving cluster-wide storage details
The following example shows the details returned for a GET request on cluster-wide storage:
from netapp_ontap import HostConnection
from netapp_ontap.resources import ClusterSpace
with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
resource = ClusterSpace()
resource.get()
print(resource)
ClusterSpace(
{
"efficiency": {
"logical_used": 1212416,
"savings": 143360,
"ratio": 1.134099616858238,
},
"efficiency_without_snapshots": {
"logical_used": 167936,
"savings": 0,
"ratio": 1.0,
},
"efficiency_without_snapshots_flexclones": {
"logical_used": 167936,
"savings": 0,
"ratio": 1.0,
},
"block_storage": {
"inactive_data": 0,
"used": 6269812736,
"physical_used": 1838284800,
"size": 56125612032,
"available": 49855799296,
"medias": [
{
"type": "ssd",
"efficiency": {"logical_used": 0, "savings": 0, "ratio": 1.0},
"efficiency_without_snapshots": {
"logical_used": 0,
"savings": 0,
"ratio": 1.0,
},
"physical_used": 1832886272,
"used": 6163390464,
"size": 9891430400,
"efficiency_without_snapshots_flexclones": {
"logical_used": 0,
"savings": 0,
"ratio": 1.0,
},
"available": 3728039936,
},
{
"type": "vmdisk",
"efficiency": {
"logical_used": 1212416,
"savings": 282624,
"ratio": 1.303964757709251,
},
"efficiency_without_snapshots": {
"logical_used": 167936,
"savings": 0,
"ratio": 1.0,
},
"physical_used": 5398528,
"used": 106422272,
"size": 46234181632,
"efficiency_without_snapshots_flexclones": {
"logical_used": 167936,
"savings": 0,
"ratio": 1.0,
},
"available": 46127759360,
},
],
},
}
)
Classes
class ClusterSpace (*args, **kwargs)
-
Provides information on cluster-wide storage details across the different tiers. Storage details include storage efficiency, block storage and cloud storage information.
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
Methods
def get (self, **kwargs) -> NetAppResponse
-
Retrieves cluster-wide storage details across the different tiers. By default, this endpoint returns all fields. Storage details include storage efficiency, block storage and cloud storage information. Supports the following roles: admin, and readonly.
Learn more
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 or if not all of the keys required are present and config.STRICT_GET has been set to True.
Inherited members
class ClusterSpaceSchema (*, 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 ClusterSpace object
Ancestors
- netapp_ontap.resource.ResourceSchema
- marshmallow.schema.Schema
- marshmallow.base.SchemaABC
Class variables
-
block_storage: ClusterSpaceBlockStorage GET POST PATCH
-
The block_storage field of the cluster_space.
-
cloud_storage: ClusterSpaceCloudStorage GET POST PATCH
-
The cloud_storage field of the cluster_space.
-
efficiency: SpaceEfficiency GET POST PATCH
-
The efficiency field of the cluster_space.
-
efficiency_without_snapshots: SpaceEfficiency GET POST PATCH
-
The efficiency_without_snapshots field of the cluster_space.
-
efficiency_without_snapshots_flexclones: SpaceEfficiency GET POST PATCH
-
The efficiency_without_snapshots_flexclones field of the cluster_space.