Metadata-Version: 2.1
Name: python-bareos
Version: 19.2.8
Summary: Client library and tools for Bareos console access.
Home-page: https://github.com/bareos/bareos/
Author: Bareos Team
Author-email: packager@bareos.com
License: AGPLv3
Description: python-bareos
        =============
        
        `python-bareos` is a Python module to access a http://www.bareos.org backup system.
        
        Packages for `python-bareos` are included in the Bareos core distribution since Bareos >= 17.2.
        
        
        Optional Requirements
        =====================
        
        TLS-PSK
        -------
        
        Since Bareos >= 18.2.4, Bareos can use TLS-PSK (Transport-Layer-Security Pre-Shared-Key) to secure its network connections.
        
        This subset of TLS is currently not supported by the Python SSL module.
        To enable this feature in `python-bareos` the Python module `sslpsk` must be installed:
        
        .. code::
        
          pip install sslpsk
        
        
        
        Examples
        ========
        
        Calling bareos-director user agent commands
        -------------------------------------------
        
        .. code:: python
        
           import bareos.bsock
           password = bareos.bsock.Password('secret')
           directorconsole = bareos.bsock.DirectorConsole(address='localhost', port=9101, password=password)
           print directorconsole.call('help')
           ...
        
        To connected to a named console instead, use the `name` parameter:
        
        .. code:: python
        
           password = bareos.bsock.Password('secret')
           directorconsole=bareos.bsock.DirectorConsole(address='localhost', port=9101, name='user1', password=password)
        
        
        
        Simple version of the bconsole in Python
        ----------------------------------------
        
        .. code:: python
        
           import bareos.bsock
           password = bareos.bsock.Password('secret')
           directorconsole = bareos.bsock.DirectorConsole(address='localhost', port=9101, password=password)
           directorconsole.interactive()
           ...
        
        or use the included bconsole.py script:
        
        ..
        
           bconsole.py --debug --name=user1 --password=secret --port 9101 localhost
        
        
        Use JSON objects of the API mode 2
        ----------------------------------
        
        Requires: Bareos >= 15.2
        
        .. code:: python
        
           import bareos.bsock
           password = bareos.bsock.Password('secret')
           directorconsole = bareos.bsock.DirectorConsoleJson(address='localhost', port=9101, password=password)
           pools = directorconsole.call('list pools')
           ...
        
Keywords: bareos
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Archiving :: Backup
Requires-Python: >=2.6
Description-Content-Type: text/x-rst
Provides-Extra: TLS-PSK
