# Module `netapp_ontap.resources.global_cache_setting`

Copyright © 2023 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Overview

This API is used to retrieve and manage global nameservice cache settings.

## Examples

### Retrieving a global nameservice cache setting

The following example shows how to use the cache setting GET endpoint to retrieve the global nameservice cache setting.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import GlobalCacheSetting

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = GlobalCacheSetting()
        resource.get()
        print(resource)

Try it out

    GlobalCacheSetting({"eviction_time_interval": "P2D", "remote_fetch_enabled": True})

### Updating a global nameservice cache setting

The following example shows how to use the cache setting PATCH endpoint to update the global nameservice cache setting.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import GlobalCacheSetting

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = GlobalCacheSetting()
        resource.eviction_time_interval = "PT2H"
        resource.patch()

## Classes

`class GlobalCacheSetting (*args, **kwargs)`

  Allows interaction with GlobalCacheSetting 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

  ### Methods

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

    Retrieves a global nameservice cache setting.

    ### Related ONTAP commands

    - `vserver services name-service cache settings show`

    ### Learn more

    - `DOC /name-services/cache/setting`

    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: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Updates a global nameservice cache setting.

    ### Important notes

    - Both the cache eviction time and remote fetch option can be modified.

    ### Related ONTAP commands

    - `vserver services name-service cache settings modify`

    ### Learn more

    - `DOC /name-services/cache/setting`

    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

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class GlobalCacheSettingSchema (*, 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 GlobalCacheSetting object

  ### Ancestors

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

  ### Class variables

  `eviction_time_interval: str GET POST PATCH`

    Specifies the time interval, in ISO 8601 format after which a periodic cache eviction happens. Default is 4 hours.

    Example: PT2H

  `links: SelfLink GET`

    The links field of the global_cache_setting.

  `remote_fetch_enabled: bool GET POST PATCH`

    Indicates whether or not a node is allowed to fetch the data from a remote node.