Giter Club home page Giter Club logo

saltstack-borgbackup's Introduction

Code style: black License: MIT

Saltstack modules for BorgBackup

Execution modules

latest

latest(repository_path)

Get latest archive in repository.

Arguments:

  • repository_path: path of BorgBackup repository

archives

archives(repository_path)

List BorgBackup archives.

Arguments:

  • repository_path: path of BorgBackup repository

info

info(repository_path, archive="")

Get repository or archive information.

Arguments:

  • repository_path: path of BorgBackup repository
  • archive: name of archive

explore

explore(repository_path, archive, inpath="")

List BorgBackup archive content.

Arguments:

  • repository_path: path of BorgBackup repository
  • archive: name of archive
  • inpath: path of directory or file in the archive

extract

extract(repository_path, archive, inpath, target, strip_components=0, test=False)

Extract file or directory from BorgBackup archive.

Arguments:

  • repository_path: path of BorgBackup repository
  • archive: name of archive
  • inpath: path of directory or file in the archive to extract
  • target: destination of the extract
  • strip_components: remove the specified number of leading path elements

State modules

restore_file

restore_file(name, repository_path, archive, target_dir=None)

Restore file from BorgBackup archive.

If target_dir is not defined, the backup will be restored in original place.

Arguments:

  • name: path of item in the archive to restore
  • repository_path: path of BorgBackup repository
  • archive: name of archive
  • target_dir: destination of the restoration, default is original path

restore_directory

restore_directory(name, repository_path, archive, target_dir=None, overwrite=False)

Restore from BorgBackup archive.

If target_dir is not defined, the backup will be restored in place.

Arguments:

  • name: path of item in the archive to restore
  • repository_path: path of BorgBackup repository
  • archive: name of archive
  • target_dir: destination of the restoration, default is original path
  • overwrite: overwrite directory in target_dir

saltstack-borgbackup's People

Contributors

kpetremann avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.