Metadata-Version: 2.1
Name: rsync-watch
Version: 0.4.4
Summary: A Python script to monitor the execution of a rsync task.
Home-page: https://github.com/Josef-Friedrich/rsync-watch
Author: Josef Friedrich
Author-email: josef@friedrich.rocks
License: GPL3
Project-URL: Source, https://github.com/Josef-Friedrich/rsync-watch
Project-URL: Tracker, https://github.com/Josef-Friedrich/rsync-watch/issues
Description: [![pypi.org](http://img.shields.io/pypi/v/rsync_watch.svg)](https://pypi.python.org/pypi/rsync_watch)
        [![Documentation Status](https://readthedocs.org/projects/rsync-watch/badge/?version=latest)](https://rsync-watch.readthedocs.io/en/latest/?badge=latest)
        
        # rsync-watch.py
        
        A Python script to monitor the execution of a rsync task.
        
        ## Features
        
        * The script `rsync-watch.py` parses the `rsync --stats` output and
          sends this statistics to a monitoring system like Nagios or Icinga
          using the NSCA protocol.
        
        * The script `rsync-watch.py` can be configured to perform various
          checks before starting the rsync process.
        
        ```
        usage: rsync-watch.py [-h] [--host-name HOST_NAME]
                              [--dest-user-group USER_GROUP_NAME]
                              [--rsync-args RSYNC_ARGS]
                              [--action-check-failed {exception,skip}]
                              [--check-file FILE_PATH] [--check-ping DESTINATION]
                              [--check-ssh-login SSH_LOGIN] [-v]
                              [--email-from-addr EMAIL_FROM_ADDR]
                              [--email-to-addr EMAIL_TO_ADDR]
                              [--email-to-addr-critical EMAIL_TO_ADDR_CRITICAL]
                              [--email-smtp-login EMAIL_SMTP_LOGIN]
                              [--email-smtp-password EMAIL_SMTP_PASSWORD]
                              [--email-smtp-server EMAIL_SMTP_SERVER]
                              [--nsca-remote-host NSCA_REMOTE_HOST]
                              [--nsca-password NSCA_PASSWORD]
                              [--nsca-encryption-method NSCA_ENCRYPTION_METHOD]
                              [--nsca-port NSCA_PORT]
                              [--beep-activated BEEP_ACTIVATED]
                              src dest
        
        A Python script to monitor the execution of a rsync task.
        
        positional arguments:
          src                   The source ([[USER@]HOST:]SRC)
          dest                  The destination ([[USER@]HOST:]DEST)
        
        optional arguments:
          -h, --help            show this help message and exit
          --host-name HOST_NAME
                                The hostname to submit over NSCA to the monitoring.
          --dest-user-group USER_GROUP_NAME
                                Both the user name and the group name of the
                                destination will be set to this name.
          --rsync-args RSYNC_ARGS
                                Rsync CLI arguments. Insert some rsync command line
                                arguments.Wrap all arguments in one string, for
                                example: --rsync-args '--exclude "this folder"'
          -v, --version         show program's version number and exit
        
        checks:
          Perform different checks before running the rsync task.
        
          --action-check-failed {exception,skip}
                                Select action what to do when a check failed.
          --check-file FILE_PATH
                                Check if a file exists on the local machine.
          --check-ping DESTINATION
                                Check if a remote host is reachable by pinging.
                                DESTINATION can a IP address or a host name or a full
                                qualified host name.
          --check-ssh-login SSH_LOGIN
                                Check if a remote host is reachable over the network
                                by SSHing into it. SSH_LOGIN: “root@192.168.1.1” or
                                “root@example.com” or “example.com”.
        
        email:
          Generated by the config_reader.
        
          --email-from-addr EMAIL_FROM_ADDR
                                The email address of the sender.
          --email-to-addr EMAIL_TO_ADDR
                                The email address of the recipient.
          --email-to-addr-critical EMAIL_TO_ADDR_CRITICAL
                                The email address of the recipient to send critical
                                messages to.
          --email-smtp-login EMAIL_SMTP_LOGIN
                                The SMTP login name.
          --email-smtp-password EMAIL_SMTP_PASSWORD
                                The SMTP password.
          --email-smtp-server EMAIL_SMTP_SERVER
                                The URL of the SMTP server, for example:
                                `smtp.example.com:587`.
        
        nsca:
          Generated by the config_reader.
        
          --nsca-remote-host NSCA_REMOTE_HOST
                                The IP address of the NSCA remote host.
          --nsca-password NSCA_PASSWORD
                                The NSCA password.
          --nsca-encryption-method NSCA_ENCRYPTION_METHOD
                                The NSCA encryption method. The supported encryption
                                methods are: 0 1 2 3 4 8 11 14 15 16
          --nsca-port NSCA_PORT
                                The NSCA port.
        
        beep:
          Generated by the config_reader.
        
          --beep-activated BEEP_ACTIVATED
                                Activate the beep channel to report auditive messages.
        
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.5
Requires-Python: >=3.5
Description-Content-Type: text/markdown
