backup module

Copyright 2023 Sophos Ltd. All rights reserved. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class backup.Backup(api_client)[source]

Bases: object

Class for working with Backup settings.

get(name=None)[source]

Get backup details.

Parameters:

name (str, optional) – Name of backup schedule. Returns all if not specified.

Returns:

XML response converted to Python dictionary

Return type:

dict

update(backup_params, debug)[source]

Updates scheduled backup settings

Parameters:

  • backup_params (dict) – Dict containing backup settings

  • debug (bool, optional) – Enable debug mode. Defaults to False.

Keyword Arguments:

  • BackupMode (str) – Backup mode (FTP/Mail/Local)

  • BackupPrefix (str) – Backup Prefix

  • FTPServer (str, optional) – FTP Server IP Address

  • Username (str, optional) – FTP Server username

  • Password (str, optional) – FTP Server password

  • FtpPath (str, optional) – FTP Server path

  • EmailAddress (str) – Email address

  • BackupFrequency (str) – Never/Daily/Weekly/Monthly

  • Day (str) – Day

  • Hour (str) – Hour

  • Minute (str) – Minute

  • Date (str) – Numeric representation of month

  • EncryptionPassword (str, optional) – Encryption password

Returns:

XML response converted to Python dictionary

Return type:

dict