# Module `netapp_ontap.resources.configuration_backup_file`

Copyright © 2020 NetApp Inc. All rights reserved.

## Overview

This API supports creating, deleting and retrieving configuration backup files. Configuration backups can be 'cluster' or 'node' type. A 'cluster' backup contains cluster-wide configuration in addition to the configuration of each node in the cluster. A 'node' backup contains only node-specific configuration such as configuration files on the root volume and the boot variables. For creating a cluster backup, a cluster-wide job is queued. For creating a node backup, a private job local to the node is queued. In addition to the backups created using this API, ONTAP creates configuration backups automatically based on job schedules. This API supports creating configuration backups on demand only. It supports deleting and retrieving configuration backups that are created automatically or on demand. For information on configuration backup settings for automatically created backups, see `DOC /support/configuration-backup`

## Examples

### Retrieving a list of configuration backup files

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ConfigurationBackupFile

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

Try it out

    [
        ConfigurationBackupFile(
            {
                "node": {
                    "uuid": "5cafe0f6-499f-11e9-b644-005056bbcf93",
                    "name": "node1",
                    "_links": {
                        "self": {
                            "href": "/api/cluster/nodes/5cafe0f6-499f-11e9-b644-005056bbcf93"
                        }
                    },
                },
                "name": "backup1.7z",
            }
        )
    ]

### Retrieving details of the specified configuration backup file

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ConfigurationBackupFile

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = ConfigurationBackupFile(
            name="backup1.7z", **{"node.uuid": "bc2f15d0-8b93-11e9-90e9-005056bb6a30"}
        )
        resource.get()
        print(resource)

Try it out

    ConfigurationBackupFile(
        {
            "auto": False,
            "type": "cluster",
            "size": 6058408,
            "time": "2019-06-10T13:35:06-04:00",
            "node": {
                "uuid": "bc2f15d0-8b93-11e9-90e9-005056bb6a30",
                "name": "node1",
                "_links": {
                    "self": {
                        "href": "/api/cluster/nodes/bc2f15d0-8b93-11e9-90e9-005056bb6a30"
                    }
                },
            },
            "version": "9.7.0",
            "name": "backup1.7z",
            "backup_nodes": [{"name": "node1"}, {"name": "node2"}],
            "download_link": "https://10.224.66.113/backups/backup1.7z",
        }
    )

### Creating a configuration backup file

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ConfigurationBackupFile

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = ConfigurationBackupFile()
        resource.node.uuid = "ac13c636-4fc9-11e9-94c2-005056bb2516"
        resource.node.name = "node1"
        resource.name = "backup3.7z"
        resource.post(hydrate=True)
        print(resource)

Try it out

    ConfigurationBackupFile(
        {
            "node": {"uuid": "ac13c636-4fc9-11e9-94c2-005056bb2516", "name": "node1"},
            "name": "backup3.7z",
        }
    )

### Deleting a configuration backup file

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import ConfigurationBackupFile

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = ConfigurationBackupFile(
            name="backup1.7z", **{"node.uuid": "5cafe0f6-499f-11e9-b644-005056bbcf93"}
        )
        resource.delete()

## Classes

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

  The configuration backup file.

  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`

    Retrieves a list of configuration backup files.

    ### Related ONTAP commands

    - `system configuration backup show`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

    Fetch a count of all objects of this type from the host.

    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, body: typing.Union = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes a configuration backup.

    ### Related ONTAP commands

    - `system configuration backup delete`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

    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.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `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 find(*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves a list of configuration backup files.

    ### Related ONTAP commands

    - `system configuration backup show`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

    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) -> typing.Iterable`

    Retrieves a list of configuration backup files.

    ### Related ONTAP commands

    - `system configuration backup show`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

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

  ### Methods

  `def delete(self, body: typing.Union = None, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Deletes a configuration backup.

    ### Related ONTAP commands

    - `system configuration backup delete`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

    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.
    `**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 the specified configuration backup file.

    ### Related ONTAP commands

    - `system configuration backup show`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

    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 post(self, hydrate: bool = False, poll: bool = True, poll_interval: typing.Union = None, poll_timeout: typing.Union = None, **kwargs) -> NetAppResponse`

    Creates a configuration backup. The required backup file name must end with .7z extension.

    ### Required properties

    - `node.uuid` or `node.name` - The node UUID or node name on which the configuration backup will be created.
    - `name` - The backup file name

    ### Related ONTAP commands

    - `system configuration backup create`

    ### Learn more

    - `DOC /support/configuration-backup/backups`

    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.
    `**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 ConfigurationBackupFileSchema (*, only: typing.Union = None, exclude: typing.Union = (), many: bool = False, context: typing.Dict = None, load_only: typing.Union = (), dump_only: typing.Union = (), partial: typing.Union = False, unknown: str = None)`

  The fields of the ConfigurationBackupFile object

  ### Ancestors

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

  ### Class variables

  `auto GET`

    Indicates if the backup was created automatically.

  `backup_nodes GET`

    The list of nodes included in the backup.

  `download_link GET`

    The link to download the backup file.

    Example: https://10.224.65.198/backups/backup_file.7z

  `name GET POST`

    The backup name.

    Example: backup_file.7z

  `node GET POST`

    The node field of the configuration_backup_file.

  `size GET`

    The size of the backup in bytes.

    Example: 4787563

  `time GET`

    The backup creation time.

    Example: 2019-02-04T18:33:48.000+0000

  `type GET`

    The backup type.

    Valid choices:

    - node
    - cluster
  `version GET`

    The software version.

    Example: 9.7.0