Module netapp_ontap.resources.snapshot

Copyright © 2024 NetApp Inc. All rights reserved.

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

Overview

A snapshot is the view of the filesystem as it exists at the time when the snapshot is created.
In ONTAP, different types of snapshots are supported, such as scheduled snapshots, user requested snapshots, SnapMirror snapshots, and so on.
ONTAP snapshot APIs allow you to create, modify, delete and retrieve snapshots.
ONTAP Bulk snapshot APIs allow you to create, modify, delete and retrieve snapshots on multiple volumes in one request.

Snapshot APIs

The following APIs are used to perform operations related to snapshots.

  • POST /api/storage/volumes/{volume.uuid}/snapshots
  • GET /api/storage/volumes/{volume.uuid}/snapshots
  • GET /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
  • PATCH /api/storage/volumes/{volume.uuid}/snapshots/{uuid}
  • DELETE /api/storage/volumes/{volume.uuid}/snapshots/{uuid} The following APIs are used to perform bulk operations related to snapshots.

  • POST /api/storage/volumes/*/snapshots

  • GET /api/storage/volumes/*/snapshots
  • PATCH /api/storage/volumes/*/snapshots/{uuid}
  • DELETE /api/storage/volumes/*/snapshots/{uuid}

Examples

Creating a snapshot

The POST operation is used to create a snapshot with the specified attributes.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot("{volume.uuid}")
    resource.name = "snapshot_copy"
    resource.comment = "Store this copy."
    resource.post(hydrate=True)
    print(resource)

Snapshot(
    {
        "name": "snapshot_copy",
        "svm": {"name": "vs0", "uuid": "8139f958-3c6e-11e9-a45f-005056bbc848"},
        "comment": "Store this copy.",
        "volume": {"name": "v2"},
    }
)

Retrieving snapshot attributes

The GET operation is used to retrieve snapshot attributes.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(list(Snapshot.get_collection("{volume.uuid}")))

[
    Snapshot(
        {
            "name": "hourly.2019-03-13_1305",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/402b6c73-73a0-4e89-a58a-75ee0ab3e8c0"
                }
            },
            "uuid": "402b6c73-73a0-4e89-a58a-75ee0ab3e8c0",
        }
    ),
    Snapshot(
        {
            "name": "hourly.2019-03-13_1405",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/f0dd497f-efe8-44b7-a4f4-bdd3890bc0c8"
                }
            },
            "uuid": "f0dd497f-efe8-44b7-a4f4-bdd3890bc0c8",
        }
    ),
    Snapshot(
        {
            "name": "hourly.2019-03-13_1522",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/02701900-51bd-46b8-9c77-47d9a9e2ce1d"
                }
            },
            "uuid": "02701900-51bd-46b8-9c77-47d9a9e2ce1d",
        }
    ),
]

Creating bulk snapshots

The POST operation is used to create a snapshot with the same name on multiple volumes in one request. This operation accepts a volume UUID or volume name and SVM, and a snapshot name. This operation only supports SnapMirror label attributes to be added to snapshots during creation.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot("*")
    resource.records = [
        {
            "volume.uuid": "e8815adb-5209-11ec-b4ad-005056bbc3e8",
            "name": "snapshot_copy",
        },
        {
            "volume.uuid": "efda9101-5209-11ec-b4ad-005056bbc3e8",
            "name": "snapshot_copy",
        },
    ]
    resource.post(hydrate=True)
    print(resource)

Snapshot({})

Retrieving snapshot advanced attributes

A collection GET request is used to calculate the amount of snapshot reclaimable space. When the advanced privilege field 'reclaimable space' is requested, the API returns the amount of reclaimable space for the queried list of snapshots.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            Snapshot.get_collection(
                "{volume.uuid}",
                fields="reclaimable_space",
                name="hourly.2019-03-13_1305|hourly.2019-03-13_1405|hourly.2019-03-13_1522",
            )
        )
    )

[
    Snapshot(
        {
            "name": "hourly.2019-03-13_1305",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/402b6c73-73a0-4e89-a58a-75ee0ab3e8c0"
                }
            },
            "uuid": "402b6c73-73a0-4e89-a58a-75ee0ab3e8c0",
        }
    ),
    Snapshot(
        {
            "name": "hourly.2019-03-13_1405",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/f0dd497f-efe8-44b7-a4f4-bdd3890bc0c8"
                }
            },
            "uuid": "f0dd497f-efe8-44b7-a4f4-bdd3890bc0c8",
        }
    ),
    Snapshot(
        {
            "name": "hourly.2019-03-13_1522",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/02701900-51bd-46b8-9c77-47d9a9e2ce1d"
                }
            },
            "uuid": "02701900-51bd-46b8-9c77-47d9a9e2ce1d",
        }
    ),
]

Retrieving snapshot advanced attributes

A collection GET request is used to calculate the delta between two snapshots. When the advanced privilege field 'delta' is requested, the API returns the delta between the queried snapshots.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            Snapshot.get_collection(
                "{volume.uuid}",
                fields="delta",
                name="hourly.2022-06-29_1105,hourly.2022-06-29_1205",
            )
        )
    )

[
    Snapshot(
        {
            "name": "hourly.2022-06-29_1105",
            "uuid": "52a2247a-7735-4a92-bc3c-e51df1fe502f",
            "delta": {"size_consumed": 675840, "time_elapsed": "PT3H27M45S"},
        }
    ),
    Snapshot(
        {
            "name": "hourly.2022-06-29_1205",
            "uuid": "b399eb34-44fe-4689-9fb5-c8f72162dd77",
            "delta": {"size_consumed": 507904, "time_elapsed": "PT2H27M45S"},
        }
    ),
]

Retrieving the attributes of a specific snapshot

The GET operation is used to retrieve the attributes of a specific snapshot.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot(
        "0353dc05-405f-11e9-acb6-005056bbc848",
        uuid="402b6c73-73a0-4e89-a58a-75ee0ab3e8c0",
    )
    resource.get()
    print(resource)

Snapshot(
    {
        "name": "hourly.2019-03-13_1305",
        "_links": {
            "self": {
                "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/402b6c73-73a0-4e89-a58a-75ee0ab3e8c0"
            }
        },
        "svm": {
            "name": "vs0",
            "_links": {
                "self": {"href": "/api/svm/svms/8139f958-3c6e-11e9-a45f-005056bbc848"}
            },
            "uuid": "8139f958-3c6e-11e9-a45f-005056bbc848",
        },
        "uuid": "402b6c73-73a0-4e89-a58a-75ee0ab3e8c0",
        "create_time": "2019-03-13T13:05:00-04:00",
        "size": 122880,
        "volume": {
            "name": "v2",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848"
                }
            },
            "uuid": "0353dc05-405f-11e9-acb6-005056bbc848",
        },
    }
)

Retrieving the advanced attributes of a specific snapshot

The GET operation is used to retrieve the attributes of a specific snapshot. Snapshot reclaimable space can be requested during a GET request. When the advanced privilege field reclaimable space is requested, the API returns the amount of reclaimable space for the snapshot.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot(
        "0353dc05-405f-11e9-acb6-005056bbc848",
        uuid="402b6c73-73a0-4e89-a58a-75ee0ab3e8c0",
    )
    resource.get(fields="**")
    print(resource)

Snapshot(
    {
        "name": "hourly.2019-03-13_1305",
        "_links": {
            "self": {
                "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848/snapshots/402b6c73-73a0-4e89-a58a-75ee0ab3e8c0"
            }
        },
        "reclaimable_space": 167832,
        "svm": {
            "name": "vs0",
            "_links": {
                "self": {"href": "/api/svm/svms/8139f958-3c6e-11e9-a45f-005056bbc848"}
            },
            "uuid": "8139f958-3c6e-11e9-a45f-005056bbc848",
        },
        "uuid": "402b6c73-73a0-4e89-a58a-75ee0ab3e8c0",
        "volume": {
            "name": "v2",
            "_links": {
                "self": {
                    "href": "/api/storage/volumes/0353dc05-405f-11e9-acb6-005056bbc848"
                }
            },
            "uuid": "0353dc05-405f-11e9-acb6-005056bbc848",
        },
    }
)

Retrieving snapshot advanced attributes

A collection GET request is used to calculate the delta between two snapshots. When the advanced privilege field 'delta' is requested, the API returns the delta between the queried snapshots.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    print(
        list(
            Snapshot.get_collection(
                "{volume.uuid}",
                fields="delta",
                name="hourly.2022-06-29_1105,hourly.2022-06-29_1205",
            )
        )
    )

[
    Snapshot(
        {
            "name": "hourly.2022-06-29_1105",
            "uuid": "52a2247a-7735-4a92-bc3c-e51df1fe502f",
            "delta": {"size_consumed": 675840, "time_elapsed": "PT3H27M45S"},
        }
    ),
    Snapshot(
        {
            "name": "hourly.2022-06-29_1205",
            "uuid": "b399eb34-44fe-4689-9fb5-c8f72162dd77",
            "delta": {"size_consumed": 507904, "time_elapsed": "PT2H27M45S"},
        }
    ),
]

Retrieving bulk snapshots

The bulk GET operation is used to retrieve snapshot attributes across all volumes.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

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

[
    Snapshot(
        {
            "name": "daily.2021-11-18_0010",
            "uuid": "3edba912-5507-4535-adce-e12fe5c0e31c",
            "volume": {"name": "v1", "uuid": "966c285f-47f7-11ec-8407-005056bbc08f"},
        }
    ),
    Snapshot(
        {
            "name": "hourly.2021-11-18_0705",
            "uuid": "3ad61153-d5ef-495d-8e0e-5c3b8bbaf5e6",
            "volume": {"name": "v1", "uuid": "966c285f-47f7-11ec-8407-005056bbc08f"},
        }
    ),
    Snapshot(
        {
            "name": "daily.2021-11-18_0010",
            "uuid": "3dd0fa97-65d9-41ea-a99d-5ceb9d2f55c5",
            "volume": {"name": "v2", "uuid": "99c974e3-47f7-11ec-8407-005056bbc08f"},
        }
    ),
    Snapshot(
        {
            "name": "hourly.2021-11-18_0705",
            "uuid": "6ca20a52-c342-4753-8865-3693fa9b7e23",
            "volume": {"name": "v2", "uuid": "99c974e3-47f7-11ec-8407-005056bbc08f"},
        }
    ),
]

Updating a snapshot

The PATCH operation is used to update the specific attributes of a snapshot.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot(
        "0353dc05-405f-11e9-acb6-005056bbc848",
        uuid="16f7008c-18fd-4a7d-8485-a0e290d9db7f",
    )
    resource.name = "snapshot_copy_new"
    resource.patch()

Updating bulk snapshots

The bulk PATCH operation is used to update the specific attributes of snapshots across volumes in a single request.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot("*")
    resource.records = [
        {
            "volume.uuid": "e8815adb-5209-11ec-b4ad-005056bbc3e8",
            "svm.uuid": "d0e6def5-5209-11ec-b4ad-005056bbc3e8",
            "uuid": "f9b7714d-1166-410a-b143-874f27969db6",
            "comment": "yay",
        },
        {
            "volume.uuid": "efda9101-5209-11ec-b4ad-005056bbc3e8",
            "svm.uuid": "d0e6def5-5209-11ec-b4ad-005056bbc3e8",
            "uuid": "514c82a7-bff7-48e2-a13c-5337b09ed41e",
            "comment": "yay",
        },
    ]
    resource.patch()

Deleting a snapshot

The DELETE operation is used to delete a snapshot.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot(
        "0353dc05-405f-11e9-acb6-005056bbc848",
        uuid="16f7008c-18fd-4a7d-8485-a0e290d9db7f",
    )
    resource.delete()

Deleting bulk snapshots

The bulk DELETE operation is used to delete a snapshots across volumes in a single request.

from netapp_ontap import HostConnection
from netapp_ontap.resources import Snapshot

with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
    resource = Snapshot("*")
    resource.delete(
        body={
            "records": [
                {
                    "volume.uuid": "e8815adb-5209-11ec-b4ad-005056bbc3e8",
                    "uuid": "f9b7714d-1166-410a-b143-874f27969db6",
                },
                {
                    "volume.uuid": "efda9101-5209-11ec-b4ad-005056bbc3e8",
                    "uuid": "1d55c97a-25f3-4366-bfa8-9ea75c255469",
                },
            ]
        }
    )

Classes

class Snapshot (*args, **kwargs)

The snapshot object represents a point in time snapshot of a volume.

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

Returns a count of all Snapshot resources that match the provided query


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, records: Iterable[ForwardRef('Snapshot')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Deletes a Volume snapshot.

Platform Specifics

  • ASA r2: POST is not supported.
  • snapshot delete

Learn more


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.
records
Can be provided in place of a query. If so, this list of objects will be deleted from the host.
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.
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 deleted.

Returns

A NetAppResponse object containing the details of the HTTP response.

Raises

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

def fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]

Returns a list of RawResources that represent Snapshot resources that match the provided query


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
raw
return a list of netapp_ontap.resource.RawResource objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
**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 find (*args, connection: HostConnection = None, **kwargs) -> Resource

Retrieves a collection of volume snapshots.

Expensive properties

There is an added computational cost to retrieving the amount of reclaimable space for snapshots, as the calculation is done on demand based on the list of snapshots provided. * reclaimable_space * delta

  • snapshot show
  • snapshot compute-reclaimable
  • snapshot show-delta

Learn more


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]

Retrieves a collection of volume snapshots.

Expensive properties

There is an added computational cost to retrieving the amount of reclaimable space for snapshots, as the calculation is done on demand based on the list of snapshots provided. * reclaimable_space * delta

  • snapshot show
  • snapshot compute-reclaimable
  • snapshot show-delta

Learn more


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
raw
return a list of netapp_ontap.resource.RawResource objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
**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, records: Iterable[ForwardRef('Snapshot')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse

Updates a Volume snapshot.

Platform Specifics

  • ASA r2: POST is not supported.
  • snapshot modify
  • snapshot rename

Learn more


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. The body argument will be ignored if records is provided.
*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.
records
Can be provided in place of a query. If so, this list of objects will be patched on the host.
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.
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 post_collection (records: Iterable[ForwardRef('Snapshot')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> Union[List[Snapshot], NetAppResponse]

Creates a volume snapshot.

Platform Specifics

  • ASA r2: POST is not supported.

Required properties

  • name - Name of the snapshot to be created.
  • comment - Comment associated with the snapshot.
  • expiry_time - snapshots with an expiry time set are not allowed to be deleted until the retention time is reached.
  • snapmirror_label - Label for SnapMirror operations.
  • snaplock_expiry_time - Expiry time for snapshot locking enabled volumes.
  • snapshot create

Learn more


Send this collection of objects to the host as a creation request.

Args

records
A list of Resource objects to send to the server to be created.
*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 create a bar for a particular foo, the foo.name value should be passed.
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 each object. When hydrate is set to True, poll must also be set to True.
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.
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 list of Resource objects matching the provided type which have been created by the host and returned. This is not the same list that was provided, so to continue using the object, you should save this list. If poll is set to False, then a NetAppResponse object is returned instead.

Raises

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

Methods

def delete (self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Deletes a Volume snapshot.

Platform Specifics

  • ASA r2: POST is not supported.
  • snapshot delete

Learn more


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.
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 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 details of a specific volume snapshot.

  • snapshot show

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.

def patch (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse

Updates a Volume snapshot.

Platform Specifics

  • ASA r2: POST is not supported.
  • snapshot modify
  • snapshot rename

Learn more


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

Creates a volume snapshot.

Platform Specifics

  • ASA r2: POST is not supported.

Required properties

  • name - Name of the snapshot to be created.
  • comment - Comment associated with the snapshot.
  • expiry_time - snapshots with an expiry time set are not allowed to be deleted until the retention time is reached.
  • snapmirror_label - Label for SnapMirror operations.
  • snaplock_expiry_time - Expiry time for snapshot locking enabled volumes.
  • snapshot create

Learn more


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

class SnapshotSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool | None = None, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

The fields of the Snapshot object

Ancestors

  • netapp_ontap.resource.ResourceSchema
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC
  • abc.ABC

Class variables

comment: str GET POST PATCH

A comment associated with the snapshot. This is an optional attribute for POST or PATCH.

create_time: ImpreciseDateTime GET

Creation time of the snapshot. It is the volume access time when the snapshot was created.

Example: 2019-02-04T19:00:00.000+0000

delta: SnapshotDelta GET POST PATCH

Reports the amount of space consumed between two WAFL file systems, in bytes. The two WAFL file systems should be specified in a comma-separated format using the "name" parameter. To determine the space consumed between a snapshot and the Active File System, only the snapshot name needs to be mentioned.

expiry_time: ImpreciseDateTime GET POST PATCH

The expiry time for the snapshot. This is an optional attribute for POST or PATCH. Snapshots with an expiry time set are not allowed to be deleted until the retention time is reached.

Example: 2019-02-04T19:00:00.000+0000

The links field of the snapshot.

logical_size: Size GET

Size of the logical used file system at the time the snapshot is captured.

Example: 1228800

name: str GET POST PATCH

Snapshot. Valid in POST or PATCH.

Example: this_snapshot

owners: List[str] GET

The owners field of the snapshot.

provenance_volume: SnapshotProvenanceVolume GET POST PATCH

The provenance_volume field of the snapshot.

reclaimable_space: Size GET POST PATCH

Space reclaimed when the snapshot is deleted, in bytes.

size: Size GET

Size of the active file system at the time the snapshot is captured. The actual size of the snapshot also includes those blocks trapped by other snapshots. On a snapshot deletion, the "size" amount of blocks is the maximum number of blocks available. On a snapshot restore, the "afs-used size" value will match the snapshot "size" value.

Example: 122880

snaplock: SnapshotSnaplock GET POST PATCH

The snaplock field of the snapshot.

snaplock_expiry_time: ImpreciseDateTime GET POST PATCH

SnapLock expiry time for the snapshot, if the snapshot is taken on a SnapLock volume. A snapshot is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time. This option can be set during snapshot POST and snapshot PATCH on snapshot locking enabled volumes. This field will no longer be supported in a future release. Use snaplock.expiry_time instead.

Example: 2019-02-04T19:00:00.000+0000

snapmirror_label: str GET POST PATCH

Label for SnapMirror operations

state: str GET

State of the FlexGroup volume snapshot. In the "pre_conversion" state, the snapshot was created before converting the FlexVol to a FlexGroup volume. A recently created snapshot can be in the "unknown" state while the system is calculating the state. In the "partial" state, the snapshot is consistent but exists only on the subset of the constituents that existed prior to the FlexGroup's expansion. Partial snapshots cannot be used for a snapshot restore operation. A snapshot is in an "invalid" state when it is present in some FlexGroup constituents but not in others. At all other times, a snapshot is valid.

Valid choices:

  • valid
  • invalid
  • partial
  • unknown
  • pre_conversion
svm: Svm GET POST PATCH

The svm field of the snapshot.

uuid: str GET

The UUID of the snapshot in the volume that uniquely identifies the snapshot in that volume.

Example: 1cd8a442-86d1-11e0-ae1c-123478563412

version_uuid: str GET

The 128 bit identifier that uniquely identifies a snapshot and its logical data layout.

Example: 1cd8a442-86d1-11e0-ae1c-123478563412

volume: Volume GET POST PATCH

The volume field of the snapshot.