# Module `netapp_ontap.resources.cluster_space`

Copyright © 2023 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)

Try it out

    ClusterSpace(
        {
            "efficiency_without_snapshots": {
                "ratio": 1.0,
                "savings": 0,
                "logical_used": 167936,
            },
            "block_storage": {
                "used": 6269812736,
                "inactive_data": 0,
                "size": 56125612032,
                "medias": [
                    {
                        "efficiency_without_snapshots": {
                            "ratio": 1.0,
                            "savings": 0,
                            "logical_used": 0,
                        },
                        "used": 6163390464,
                        "type": "ssd",
                        "size": 9891430400,
                        "efficiency_without_snapshots_flexclones": {
                            "ratio": 1.0,
                            "savings": 0,
                            "logical_used": 0,
                        },
                        "efficiency": {"ratio": 1.0, "savings": 0, "logical_used": 0},
                        "physical_used": 1832886272,
                        "available": 3728039936,
                    },
                    {
                        "efficiency_without_snapshots": {
                            "ratio": 1.0,
                            "savings": 0,
                            "logical_used": 167936,
                        },
                        "used": 106422272,
                        "type": "vmdisk",
                        "size": 46234181632,
                        "efficiency_without_snapshots_flexclones": {
                            "ratio": 1.0,
                            "savings": 0,
                            "logical_used": 167936,
                        },
                        "efficiency": {
                            "ratio": 1.303964757709251,
                            "savings": 282624,
                            "logical_used": 1212416,
                        },
                        "physical_used": 5398528,
                        "available": 46127759360,
                    },
                ],
                "physical_used": 1838284800,
                "available": 49855799296,
            },
            "efficiency_without_snapshots_flexclones": {
                "ratio": 1.0,
                "savings": 0,
                "logical_used": 167936,
            },
            "efficiency": {
                "ratio": 1.134099616858238,
                "savings": 143360,
                "logical_used": 1212416,
            },
        }
    )

## 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

  - Resource

  ### 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

    - `DOC /storage/cluster`

    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

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`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.