doc/man8/untangle-https-backup.8

   1 .TH untangle\-https\-backup 8
   2
   3 .SH NAME
   4 untangle\-https\-backup \- Back up Untangle configurations via the web admin UI
   5 .SH SYNOPSIS
   6 \fBuntangle\-https\-backup\fR [\fB\-\-config\-file <INI file>\fR]
   7 .SH INPUT
   8 .P
   9 None; the program's behavior is entirely determined by its
  10 configuration (INI) file.
  11 .SH OUTPUT
  12 .P
  13 Errors are output to \fIstderr\fR; otherwise, silence is golden.
  14 .SH DESCRIPTION
  15 .P
  16 The Untangle web UI provides a way to create backups of the local
  17 configuration. However, if you manage enough Untangle installations,
  18 it becomes impractical to log in to each one and navigate to the
  19 backups in a browser. The untangle\-https\-backup program automates that
  20 process for a list of installations contained in a configuration file.
  21 .P
  22 By default, the INI-style configuration file is located at
  23 /etc/untangle\-https\-backup.ini, but that can be overridden by the
  24 \fB\-\-config\-file\fR option.
  25 .SH CONFIGURATION FILE
  26 The configuration file is an INI-style list of Untangle installations
  27 to back up. An example entry is,
  28
  29 .nf
  30 [Test installation]
  31 host = 192.168.1.100
  32 username = testuser
  33 password = hunter2
  34 .fi
  35
  36 There are currently five parameters that may be set for each
  37 installation:
  38
  39 .IP \fBhost\fR\ (required)
  40 The hostname or IP address where the Untangle web UI is available.
  41 .IP \fBusername\fR\ (default:\ \fIadmin\fR)
  42 The Untangle admin username.
  43 .IP \fBpassword\fR\ (required)
  44 The Untangle admin password.
  45 .IP \fBversion\fR\ (default:\ \fI14.1\fR)
  46 The major version of Untangle running on this host. Versions \fI9\fR,
  47 \fI10\fR, \fI11\fR, \fI12\fR, \fI13\fR, \fI13.1\fR, \fI14\fR, and
  48 \fI14.1\fR are supported.
  49 .IP \fBverify_cert\fR\ (default:\ \fIFalse\fR)
  50 Whether or not to verify the site's SSL certificate, either
  51 \fITrue\fR or \fIFalse\fR.
  52 .IP \fBtimeout\fR\ (default:\ \fI300\fR)
  53 How long to wait for socket operations to complete, in seconds.
  54 .SH EXAMPLES
  55 .P
  56 It is difficult to invoke untangle-https-backup incorrectly:
  57
  58 .nf
  59 .I $ untangle\-https\-backup
  60 .fi
  61
  62 Show the usage information:
  63
  64 .nf
  65 .I $ untangle\-https\-backup \-\-help
  66 .fi
  67
  68 Specify an alternate configuration file:
  69
  70 .nf
  71 .I $ untangle\-https\-backup \-\-config\-file /etc/foo.ini
  72 .fi
  73 .SH OPTIONS
  74
  75 .IP \fB\-\-config\-file\fR,\ \fB\-c\fR\ (default:\ \fI/etc/untangle\-https\-backup.ini\fR)
  76 Path to the configuration file.
  77 .
  78 .SH BUGS
  79 .P
  80 Send bugs to michael@orlitzky.com.