# Module `netapp_ontap.resources.shadowcopy`

Copyright © 2023 NetApp Inc. All rights reserved.

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

Microsoft Remote Volume Shadow Copy Services (VSS) is an extension of the existing Microsoft VSS infrastructure. Previously, VSS could be used for backup services only for data stored on the local disk. This limited the use of VSS to applications that stored data either on a local disk or on SAN-based storage. With Remote VSS, Microsoft has extended the VSS infrastructure to support the shadow copying of SMB shares. Server applications, such as, Hyper-V are now storing VHD files on SMB file shares. With these new extensions, it is possible to take application consistent shadow copies for virtual machines that store data and configuration files on shares.

### Retrieving Shadow copy sets for all SVMs

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ShadowcopySet

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

Try it out

    [
        ShadowcopySet(
            {
                "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
                "keep_snapshots": True,
                "uuid": "27ed1b79-97f6-11ec-8ad1-0050568e57be",
            }
        ),
        ShadowcopySet(
            {
                "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
                "keep_snapshots": False,
                "uuid": "388be551-97f6-11ec-8ad1-0050568e57be",
            }
        ),
        ShadowcopySet(
            {
                "svm": {"uuid": "fdb5bd8b-9498-11ec-9f9d-0050568e57be", "name": "vs2"},
                "keep_snapshots": False,
                "uuid": "525104ef-9f96-11ec-82fd-0050568e57be",
            }
        ),
        ShadowcopySet(
            {
                "svm": {"uuid": "fdb5bd8b-9498-11ec-9f9d-0050568e57be", "name": "vs2"},
                "keep_snapshots": True,
                "uuid": "66f8f723-9f96-11ec-82fd-0050568e57be",
            }
        ),
    ]

### Retrieving information for a specific shadow copy set

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ShadowcopySet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = ShadowcopySet(uuid="525104ef-9f96-11ec-82fd-0050568e57be")
        resource.get(fields="*")
        print(resource)

Try it out

    ShadowcopySet(
        {
            "svm": {"uuid": "fdb5bd8b-9498-11ec-9f9d-0050568e57be", "name": "vs2"},
            "keep_snapshots": False,
            "uuid": "525104ef-9f96-11ec-82fd-0050568e57be",
        }
    )

### Updating the keep-snapshot property of a specific shadow copy set

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ShadowcopySet

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = ShadowcopySet(uuid="525104ef-9f96-11ec-82fd-0050568e57be")
        resource.keep_snapshots = True
        resource.patch()

### Retrieving shadow copy information for all SVMs

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Shadowcopy

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

Try it out

    [
        Shadowcopy(
            {
                "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
                "share": {"name": "sh1"},
                "shadowcopy_set": {"uuid": "9169cd4a-a421-11ec-b82e-0050568e57be"},
                "volume": {"uuid": "e117c8f6-9498-11ec-9f9d-0050568e57be", "name": "vol1"},
                "client_uuid": "918536b7-a421-11ec-b82e-0050568e57be",
                "uuid": "919fbc80-a421-11ec-b82e-0050568e57be",
            }
        ),
        Shadowcopy(
            {
                "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
                "share": {"name": "sh2"},
                "shadowcopy_set": {"uuid": "9169cd4a-a421-11ec-b82e-0050568e57be"},
                "volume": {"uuid": "e117c8f6-9498-11ec-9f9d-0050568e57be", "name": "vol1"},
                "client_uuid": "91a9252b-a421-11ec-b82e-0050568e57be",
                "uuid": "91ac5a5f-a421-11ec-b82e-0050568e57be",
            }
        ),
        Shadowcopy(
            {
                "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
                "share": {"name": "sh3"},
                "shadowcopy_set": {"uuid": "9169cd4a-a421-11ec-b82e-0050568e57be"},
                "volume": {"uuid": "e117c8f6-9498-11ec-9f9d-0050568e57be", "name": "vol1"},
                "client_uuid": "91adfc85-a421-11ec-b82e-0050568e57be",
                "uuid": "91b14098-a421-11ec-b82e-0050568e57be",
            }
        ),
        Shadowcopy(
            {
                "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
                "share": {"name": "sh4"},
                "shadowcopy_set": {"uuid": "9169cd4a-a421-11ec-b82e-0050568e57be"},
                "volume": {"uuid": "e117c8f6-9498-11ec-9f9d-0050568e57be", "name": "vol1"},
                "client_uuid": "91b2f817-a421-11ec-b82e-0050568e57be",
                "uuid": "91b63309-a421-11ec-b82e-0050568e57be",
            }
        ),
    ]

### Retrieving information for a specific shadow copy

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Shadowcopy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Shadowcopy(client_uuid="91adfc85-a421-11ec-b82e-0050568e57be")
        resource.get(fields="*")
        print(resource)

Try it out

    Shadowcopy(
        {
            "svm": {"uuid": "dfb8e00d-9498-11ec-9f9d-0050568e57be", "name": "vs1"},
            "share": {"name": "sh3"},
            "shadowcopy_set": {"uuid": "9169cd4a-a421-11ec-b82e-0050568e57be"},
            "volume": {"uuid": "e117c8f6-9498-11ec-9f9d-0050568e57be", "name": "vol1"},
            "client_uuid": "91adfc85-a421-11ec-b82e-0050568e57be",
            "uuid": "91b14098-a421-11ec-b82e-0050568e57be",
        }
    )

### Updating the list of files to be shadowcopied in a particular share

## Use this endpoint to update the list of files to be shadow copied in a particular share. Set "restore" field as false to perform this operation.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import Shadowcopy

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = Shadowcopy(client_uuid="91adfc85-a421-11ec-b82e-0050568e57be")
        resource.files = ["/vhd1", "/vhd2"]
        resource.patch(hydrate=True, restore=False)

### Requesting the storage system to restore a directory

## You set restore field to true to perform this operation. Only users with the security login role "vsadmin" can perform the operation.

    # The API:
    PATCH /protocols/cifs/shadow-copies?restore=true
    # The call:
    PATCH "api/protocols/cifs/shadow-copies?restore=true" -d "{  \"destination_dir\": \"/dir2\",  \"source_dir\": \"/src_dir\",  \"volume\": {    \"name\": \"test_vol\"  },  \"with_content\": false}"

## Classes

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

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

  ### Static methods

  `def count_collection (*args, connection: HostConnection = None, **kwargs) -> int`

    Returns a count of all Shadowcopy 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 fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]`

    Returns a list of RawResources that represent Shadowcopy 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 Shadowcopies

    ### Related ONTAP commands

    - `vserver cifs shadowcopy show-shares`

    ### Learn more

    - `DOC /protocols/cifs/shadow-copies`

    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 Shadowcopies

    ### Related ONTAP commands

    - `vserver cifs shadowcopy show-shares`

    ### Learn more

    - `DOC /protocols/cifs/shadow-copies`

    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('Shadowcopy')] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Specify list Files to be added as a part of Shadowcopy creation

    ### Learn more

    - `DOC /protocols/cifs/shadow-copies`

    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

  ### Methods

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

    Retrieves a Shadowcopy

    ### Related ONTAP commands

    - `vserver cifs shadowcopy show-shares`

    ### Learn more

    - `DOC /protocols/cifs/shadow-copies`

    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`

    Specify list Files to be added as a part of Shadowcopy creation

    ### Learn more

    - `DOC /protocols/cifs/shadow-copies`

    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

  ### Inherited members

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

  ### Ancestors

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

  ### Class variables

  `client_uuid: str GET`

    The universally-unique identifier of the client's shadow copy.

    Example: abc13450-1f19-40ba-9b82-ebf277517e7e

  `destination_dir: str PATCH`

    The path of the destination directory. The path is in UTF8 and uses forward slash as a directory separator. The path is relative to the root of the volume.

    Example: /dir2

  `files: List[str] GET POST PATCH`

    The list of files to shadow copy in the share. The path is in UTF8 and uses forward slash as a directory separator. The path is relative to the root of the share.

    Example: ["/vhd1","/vhd2"]

  `links: SelfLink GET`

    The links field of the shadowcopy.

  `shadowcopy_set: ShadowcopySet GET`

    The shadowcopy_set field of the shadowcopy.

  `share: CifsShare GET`

    The share field of the shadowcopy.

  `source_dir: str PATCH`

    The path of the source directory. The path is in UTF8 and uses forward slash as a directory separator. The path is relative to the root of the volume.

    Example: /dir1

  `svm: Svm GET`

    The svm field of the shadowcopy.

  `uuid: str GET`

    The universally-unique identifier of the storage's shadow copy.

    Example: fef32805-1f19-40ba-9b82-ebf277517e7e

  `volume: Volume PATCH`

    The volume field of the shadowcopy.

  `with_content: bool PATCH`

    Specifies what needs to be restored. False specifies the directory only. True indicates the directory and its content.