From 274b47fc295edc4ae43a18bb95b70fbb3cabd452 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Tue, 2 Jan 2018 13:27:12 +0100 Subject: [PATCH] add mising -synopsis.adoc files --- api-viewer/apidata.js | 183 ++++++++++++++++++++++---------- pmgbackup.1-synopsis.adoc | 57 ++++++++++ pmgcm.1-synopsis.adoc | 68 ++++++++++++ pmgmirror.8-synopsis.adoc | 40 +++++++ pmgqm.1-synopsis.adoc | 65 ++++++++++++ pmgreport.1-synopsis.adoc | 24 +++++ pmgsubscription.1-synopsis.adoc | 45 ++++++++ pmgtunnel.8-synopsis.adoc | 46 ++++++++ pmgupgrade.1-synopsis.adoc | 10 ++ pmgversion.1-synopsis.adoc | 10 ++ 10 files changed, 490 insertions(+), 58 deletions(-) create mode 100644 pmgbackup.1-synopsis.adoc create mode 100644 pmgcm.1-synopsis.adoc create mode 100644 pmgmirror.8-synopsis.adoc create mode 100644 pmgqm.1-synopsis.adoc create mode 100644 pmgreport.1-synopsis.adoc create mode 100644 pmgsubscription.1-synopsis.adoc create mode 100644 pmgtunnel.8-synopsis.adoc create mode 100644 pmgupgrade.1-synopsis.adoc create mode 100644 pmgversion.1-synopsis.adoc diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 01b6fd8..f67d189 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -5002,10 +5002,10 @@ var pmgapi = [ "accountattr" : { "default" : "sAMAccountName, uid", "description" : "Account attribute name name.", - "format" : "string-list", + "format" : "ldap-simple-attr-list", "optional" : 1, - "pattern" : "[a-zA-Z0-9]+", - "type" : "string" + "type" : "string", + "typetext" : "" }, "basedn" : { "description" : "Base domain name.", @@ -5068,18 +5068,18 @@ var pmgapi = [ "groupclass" : { "default" : "group, univentionGroup, ipausergroup", "description" : "List of objectclasses for groups.", - "format" : "string-list", + "format" : "ldap-simple-attr-list", "optional" : 1, "type" : "string", "typetext" : "" }, "mailattr" : { - "default" : "mail, userPrincipalName, proxyAddresses, othermailbox", + "default" : "mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress", "description" : "List of mail attribute names.", - "format" : "string-list", + "format" : "ldap-simple-attr-list", "optional" : 1, - "pattern" : "[a-zA-Z0-9]+", - "type" : "string" + "type" : "string", + "typetext" : "" }, "mode" : { "default" : "ldap", @@ -5523,10 +5523,10 @@ var pmgapi = [ "accountattr" : { "default" : "sAMAccountName, uid", "description" : "Account attribute name name.", - "format" : "string-list", + "format" : "ldap-simple-attr-list", "optional" : 1, - "pattern" : "[a-zA-Z0-9]+", - "type" : "string" + "type" : "string", + "typetext" : "" }, "basedn" : { "description" : "Base domain name.", @@ -5574,18 +5574,18 @@ var pmgapi = [ "groupclass" : { "default" : "group, univentionGroup, ipausergroup", "description" : "List of objectclasses for groups.", - "format" : "string-list", + "format" : "ldap-simple-attr-list", "optional" : 1, "type" : "string", "typetext" : "" }, "mailattr" : { - "default" : "mail, userPrincipalName, proxyAddresses, othermailbox", + "default" : "mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress", "description" : "List of mail attribute names.", - "format" : "string-list", + "format" : "ldap-simple-attr-list", "optional" : 1, - "pattern" : "[a-zA-Z0-9]+", - "type" : "string" + "type" : "string", + "typetext" : "" }, "mode" : { "default" : "ldap", @@ -7265,6 +7265,7 @@ var pmgapi = [ }, "dnsbl_sites" : { "description" : "Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).", + "format" : "dnsbl-entry-list", "optional" : 1, "type" : "string", "typetext" : "" @@ -7440,13 +7441,6 @@ var pmgapi = [ "type" : "boolean", "typetext" : "" }, - "use_rbl" : { - "default" : 1, - "description" : "Use Realtime Blacklists.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" - }, "verifyreceivers" : { "description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.", "enum" : [ @@ -7511,6 +7505,15 @@ var pmgapi = [ "type" : "integer", "typetext" : " (0 - 1000)" }, + "clamav_heuristic_score" : { + "default" : 3, + "description" : "Score for ClamaAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).", + "maximum" : 1000, + "minimum" : 0, + "optional" : 1, + "type" : "integer", + "typetext" : " (0 - 1000)" + }, "delete" : { "description" : "A list of settings you want to delete.", "format" : "pve-configid-list", @@ -7534,7 +7537,7 @@ var pmgapi = [ "type" : "string" }, "maxspamsize" : { - "default" : 204800, + "default" : 262144, "description" : "Maximum size of spam messages in bytes.", "minimum" : 64, "optional" : 1, @@ -10756,9 +10759,9 @@ var pmgapi = [ { "info" : { "POST" : { - "description" : "Creates a VNC Shell proxy.", + "description" : "Creates a Terminal proxy.", "method" : "POST", - "name" : "vncshell", + "name" : "termproxy", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -10774,16 +10777,14 @@ var pmgapi = [ "optional" : 1, "type" : "boolean", "typetext" : "" - }, - "websocket" : { - "default" : 1, - "description" : "use websocket instead of standard vnc.", - "optional" : 1, - "type" : "boolean", - "typetext" : "" } } }, + "permissions" : { + "check" : [ + "admin" + ] + }, "protected" : 1, "returns" : { "additionalProperties" : 0, @@ -10805,8 +10806,8 @@ var pmgapi = [ } }, "leaf" : 1, - "path" : "/nodes/{node}/vncshell", - "text" : "vncshell" + "path" : "/nodes/{node}/termproxy", + "text" : "termproxy" }, { "info" : { @@ -10838,6 +10839,11 @@ var pmgapi = [ } } }, + "permissions" : { + "check" : [ + "admin" + ] + }, "returns" : { "properties" : { "port" : { @@ -11070,6 +11076,40 @@ var pmgapi = [ }, "type" : "object" } + }, + "POST" : { + "description" : "Reboot or shutdown a node.", + "method" : "POST", + "name" : "node_cmd", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "command" : { + "description" : "Specify the command.", + "enum" : [ + "reboot", + "shutdown" + ], + "type" : "string" + }, + "node" : { + "description" : "The cluster node name.", + "format" : "pve-node", + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "admin" + ] + }, + "protected" : 1, + "proxyto" : "node", + "returns" : { + "type" : "null" + } } }, "leaf" : 1, @@ -11488,6 +11528,13 @@ var pmgapi = [ "type" : "string", "typetext" : "" }, + "path" : { + "description" : "Verify ticket, and check if user have access on 'path'", + "maxLength" : 64, + "optional" : 1, + "type" : "string", + "typetext" : "" + }, "realm" : { "description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @.", "enum" : [ @@ -12214,8 +12261,8 @@ var pmgapi = [ "properties" : { "id" : { "description" : "Unique ID", - "maxLength" : 40, - "pattern" : "C\\d+R\\d+", + "maxLength" : 60, + "pattern" : "C\\d+R\\d+T\\d+", "type" : "string" }, "raw" : { @@ -12309,8 +12356,8 @@ var pmgapi = [ }, "id" : { "description" : "Unique ID", - "maxLength" : 40, - "pattern" : "C\\d+R\\d+", + "maxLength" : 60, + "pattern" : "C\\d+R\\d+T\\d+", "type" : "string" } } @@ -13107,6 +13154,14 @@ var pmgapi = [ "returns" : { "items" : { "properties" : { + "bytes_in" : { + "description" : "Incoming mail traffic (Bytes).", + "type" : "number" + }, + "bytes_out" : { + "description" : "Outgoing mail traffic (Bytes).", + "type" : "number" + }, "count_in" : { "description" : "Incoming mail count.", "type" : "number" @@ -13119,14 +13174,6 @@ var pmgapi = [ "description" : "Domain name.", "type" : "string" }, - "mbytes_in" : { - "description" : "Incoming mail traffic (Mebibytes).", - "type" : "number" - }, - "mbytes_out" : { - "description" : "Outgoing mail traffic (Mebibytes).", - "type" : "number" - }, "spamcount_in" : { "description" : "Incoming spam mails.", "type" : "number" @@ -13249,13 +13296,21 @@ var pmgapi = [ "type" : "number" }, "junk_in" : { - "description" : "Incoming junk mail count (viruscount_in + spamcount_in + glcount + spfcount).", + "description" : "Incoming junk mail count (viruscount_in + spamcount_in + glcount + spfcount + rbl_rejects + pregreet_rejects).", "type" : "number" }, "junk_out" : { "description" : "Outgoing junk mail count (viruscount_out + spamcount_out).", "type" : "number" }, + "pregreet_rejects" : { + "description" : "PREGREET recject count.", + "type" : "integer" + }, + "rbl_rejects" : { + "description" : "Number of RBL rejects.", + "type" : "integer" + }, "spamcount_in" : { "description" : "Incoming spam mails.", "type" : "number" @@ -13537,8 +13592,16 @@ var pmgapi = [ "description" : "Time index.", "type" : "integer" }, + "pregreet_rejects" : { + "description" : "PREGREET recject count.", + "type" : "integer" + }, + "rbl_rejects" : { + "description" : "Number of RBL rejects.", + "type" : "integer" + }, "spamcount_in" : { - "description" : "Incoming spam mails (spamcount_in + glcount + spfcount).", + "description" : "Incoming spam mails (spamcount_in + glcount + spfcount + rbl_rejects + pregreet_rejects).", "type" : "number" }, "spamcount_out" : { @@ -13841,9 +13904,9 @@ var pmgapi = [ { "info" : { "GET" : { - "description" : "Mail RBL Count Statistics.", + "description" : "Early SMTP reject count statistic (RBL, PREGREET rejects with postscreen)", "method" : "GET", - "name" : "rblcount", + "name" : "rejectcount", "parameters" : { "additionalProperties" : 0, "properties" : { @@ -13879,7 +13942,7 @@ var pmgapi = [ }, "timespan" : { "default" : 3600, - "description" : "Return RBL rejects/, where is specified in seconds.", + "description" : "Return RBL/PREGREET rejects/, where is specified in seconds.", "maximum" : 31622400, "minimum" : 3600, "optional" : 1, @@ -13906,14 +13969,18 @@ var pmgapi = [ "returns" : { "items" : { "properties" : { - "count" : { - "description" : "RBL recject count.", - "type" : "number" - }, "index" : { "description" : "Time index.", "type" : "integer" }, + "pregreet_rejects" : { + "description" : "PREGREET recject count.", + "type" : "integer" + }, + "rbl_rejects" : { + "description" : "RBL recject count.", + "type" : "integer" + }, "time" : { "description" : "Time (Unix epoch).", "type" : "integer" @@ -13926,8 +13993,8 @@ var pmgapi = [ } }, "leaf" : 1, - "path" : "/statistics/rblcount", - "text" : "rblcount" + "path" : "/statistics/rejectcount", + "text" : "rejectcount" } ], "info" : { diff --git a/pmgbackup.1-synopsis.adoc b/pmgbackup.1-synopsis.adoc new file mode 100644 index 0000000..ca89d25 --- /dev/null +++ b/pmgbackup.1-synopsis.adoc @@ -0,0 +1,57 @@ +*pmgbackup* ` [ARGS] [OPTIONS]` + +*pmgbackup backup* `[OPTIONS]` + +Backup the system configuration. + +`--statistic` `` ('default =' `1`):: + +Backup statistic databases. + + + + +*pmgbackup help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`--verbose` `` :: + +Verbose output format. + + + + +*pmgbackup list* + +List all stored backups (files named proxmox-backup_{DATE}.tgz). + + + +*pmgbackup restore* `--filename ` `[OPTIONS]` + +Restore the system configuration. + +`--config` `` ('default =' `0`):: + +Restore system configuration. + +`--database` `` ('default =' `1`):: + +Restore the rule database. This is the default. + +`--filename` `pmg-backup_[0-9A-Za-z_-]+\.tgz` :: + +The backup file name. + +`--statistic` `` ('default =' `0`):: + +Restore statistic databases. Only considered when you restore the 'database'. + + + + diff --git a/pmgcm.1-synopsis.adoc b/pmgcm.1-synopsis.adoc new file mode 100644 index 0000000..492fe45 --- /dev/null +++ b/pmgcm.1-synopsis.adoc @@ -0,0 +1,68 @@ +*pmgcm* ` [ARGS] [OPTIONS]` + +*pmgcm create* + +Create initial cluster config with current node as master. + + + + +*pmgcm help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`--verbose` `` :: + +Verbose output format. + + + + +*pmgcm join* `` `[OPTIONS]` + +Join a new node to an existing cluster. + +``: `` :: + +IP address. + +`--fingerprint` `^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$` :: + +SSL certificate fingerprint. + + + +*pmgcm join_cmd* + +Prints the command for joining an new node to the cluster. You need to +execute the command on the new node. + + + + +*pmgcm status* `[OPTIONS]` + +Cluster node status. + +`--list_single_node` `` ('default =' `0`):: + +List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case. + + + + +*pmgcm sync* `[OPTIONS]` + +Synchronize cluster configuration. + +`--master_ip` `` :: + +Optional IP address for master node. + + + + diff --git a/pmgmirror.8-synopsis.adoc b/pmgmirror.8-synopsis.adoc new file mode 100644 index 0000000..04ba3e0 --- /dev/null +++ b/pmgmirror.8-synopsis.adoc @@ -0,0 +1,40 @@ +*pmgmirror* ` [ARGS] [OPTIONS]` + +*pmgmirror help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`--verbose` `` :: + +Verbose output format. + + + + +*pmgmirror restart* + +Restart the Database Mirror Daemon + + + +*pmgmirror start* `[OPTIONS]` + +Start the Database Mirror Daemon + +`--debug` `` ('default =' `0`):: + +Debug mode - stay in foreground + + + +*pmgmirror stop* + +Stop the Database Mirror Daemon + + + + diff --git a/pmgqm.1-synopsis.adoc b/pmgqm.1-synopsis.adoc new file mode 100644 index 0000000..ec8a78d --- /dev/null +++ b/pmgqm.1-synopsis.adoc @@ -0,0 +1,65 @@ +*pmgqm* ` [ARGS] [OPTIONS]` + +*pmgqm help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`--verbose` `` :: + +Verbose output format. + + + + +*pmgqm purge* `[OPTIONS]` + +Cleanup Quarantine database. Remove entries older than configured +quarantine lifetime. + +`--check` `` ('default =' `0`):: + +Only search for quarantine files older than configured quarantine lifetime. Just print found files, but do not remove them. + + + +*pmgqm send* `[OPTIONS]` + +Generate and send spam report emails. + +`--debug` `` ('default =' `0`):: + +Debug mode. Print raw email to stdout instead of sending them. + +`--receiver` `` :: + +Generate report for a single email address. If not specified, generate reports for all users. + +`--redirect` `` :: + +Redirect spam report email to this address. + +`--style` `` :: + +Spam report style. Default value is read from spam quarantine configuration. + +`--timespan` `` ('default =' `today`):: + +Select time span. + + + +*pmgqm status* `[OPTIONS]` + +Print quarantine status (mails per user) for specified time span. + +`--timespan` `` ('default =' `today`):: + +Select time span. + + + + diff --git a/pmgreport.1-synopsis.adoc b/pmgreport.1-synopsis.adoc new file mode 100644 index 0000000..c32ad60 --- /dev/null +++ b/pmgreport.1-synopsis.adoc @@ -0,0 +1,24 @@ +*pmgreport* `help` + +*pmgreport* `[OPTIONS]` + +Generate and send daily system report email. + +`--auto` `` ('default =' `0`):: + +Auto mode. Use setting from system configuration (set when invoked fron cron). + +`--debug` `` ('default =' `0`):: + +Debug mode. Print raw email to stdout instead of sending them. + +`--receiver` `` :: + +Send report to this email address. Default is the administratior email address. + +`--timespan` `` ('default =' `today`):: + +Select time span for included email statistics. ++ +NOTE: System and cluster performance data is always from current time (when script is run). + diff --git a/pmgsubscription.1-synopsis.adoc b/pmgsubscription.1-synopsis.adoc new file mode 100644 index 0000000..65644a8 --- /dev/null +++ b/pmgsubscription.1-synopsis.adoc @@ -0,0 +1,45 @@ +*pmgsubscription* ` [ARGS] [OPTIONS]` + +*pmgsubscription get* + +Read subscription info. + + + + +*pmgsubscription help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`--verbose` `` :: + +Verbose output format. + + + + +*pmgsubscription set* `` + +Set subscription key. + +``: `pmg([cbsp])-[0-9a-f]{10}` :: + +Proxmox Mail Gateway subscription key + + + +*pmgsubscription update* `[OPTIONS]` + +Update subscription info. + +`--force` `` ('default =' `0`):: + +Always connect to server, even if we have up to date info inside local cache. + + + + diff --git a/pmgtunnel.8-synopsis.adoc b/pmgtunnel.8-synopsis.adoc new file mode 100644 index 0000000..c894d64 --- /dev/null +++ b/pmgtunnel.8-synopsis.adoc @@ -0,0 +1,46 @@ +*pmgtunnel* ` [ARGS] [OPTIONS]` + +*pmgtunnel help* `[]` `[OPTIONS]` + +Get help about specified command. + +``: `` :: + +Command name + +`--verbose` `` :: + +Verbose output format. + + + + +*pmgtunnel restart* + +Restart the Cluster Tunnel Daemon + + + +*pmgtunnel start* `[OPTIONS]` + +Start the Cluster Tunnel Daemon + +`--debug` `` ('default =' `0`):: + +Debug mode - stay in foreground + + + +*pmgtunnel status* + +Print cluster tunnel status. + + + +*pmgtunnel stop* + +Stop the Cluster Tunnel Daemon + + + + diff --git a/pmgupgrade.1-synopsis.adoc b/pmgupgrade.1-synopsis.adoc new file mode 100644 index 0000000..0891546 --- /dev/null +++ b/pmgupgrade.1-synopsis.adoc @@ -0,0 +1,10 @@ +*pmgupgrade* `help` + +*pmgupgrade* `[OPTIONS]` + +Upgrade Proxmox Mail Gateway + +`--shell` `` ('default =' `0`):: + +Run an interactive shell after the update. + diff --git a/pmgversion.1-synopsis.adoc b/pmgversion.1-synopsis.adoc new file mode 100644 index 0000000..f6bea9d --- /dev/null +++ b/pmgversion.1-synopsis.adoc @@ -0,0 +1,10 @@ +*pmgversion* `help` + +*pmgversion* `[OPTIONS]` + +Print version information for Proxmox Mail Gateway packages. + +`--verbose` `` ('default =' `0`):: + +List version details for important packages. + -- 2.39.2