CedarBackup3.extend.sysinfo
===========================

.. py:module:: CedarBackup3.extend.sysinfo

.. autoapi-nested-parse::

   Provides an extension to save off important system recovery information.

   This is a simple Cedar Backup extension used to save off important system
   recovery information.  It saves off three types of information:

      - Currently-installed Debian packages via ``dpkg --get-selections``
      - Disk partition information via ``fdisk -l``
      - System-wide mounted filesystem contents, via ``ls -laR``

   The saved-off information is placed into the collect directory and is
   compressed using ``bzip2`` to save space.

   This extension relies on the options and collect configurations in the standard
   Cedar Backup configuration file, but requires no new configuration of its own.
   No public functions other than the action are exposed since all of this is
   pretty simple.

   *Note:* If the ``dpkg`` or ``fdisk`` commands cannot be found in their normal
   locations or executed by the current user, those steps will be skipped and a
   note will be logged at the INFO level.

   :author: Kenneth J. Pronovici <pronovic@ieee.org>







Module Contents
---------------

.. py:data:: logger

.. py:data:: DPKG_PATH
   :value: '/usr/bin/dpkg'


.. py:data:: FDISK_PATH
   :value: '/sbin/fdisk'


.. py:data:: DPKG_COMMAND

.. py:data:: FDISK_COMMAND

.. py:data:: LS_COMMAND
   :value: ['ls', '-laR', '/']


.. py:function:: executeAction(configPath, options, config)

   Executes the sysinfo backup action.

   :param configPath: Path to configuration file on disk
   :type configPath: String representing a path on disk
   :param options: Program command-line options
   :type options: Options object
   :param config: Program configuration
   :type config: Config object

   :raises ValueError: Under many generic error conditions
   :raises IOError: If the backup process fails for some reason


