]> git.proxmox.com Git - pmg-docs.git/blame - pmgsh.adoc
installation: update chapter based on PVE docs & new GRUB entries
[pmg-docs.git] / pmgsh.adoc
CommitLineData
93f5feff
DM
1[[chapter_pmgsh]]
2ifdef::manvolnum[]
3pmgsh(1)
4========
5:pmg-toplevel:
6
7NAME
8----
9
10pmgsh - Proxmox Mail Gateway API Shell
11
12
13SYNOPSIS
14--------
15
16include::pmgsh.1-synopsis.adoc[]
17
18
19DESCRIPTION
20-----------
21endif::manvolnum[]
22ifndef::manvolnum[]
7b3d13cc
DM
23pmgsh - API Shell
24=================
93f5feff
DM
25:pmg-toplevel:
26endif::manvolnum[]
27
7b3d13cc 28The `pmgsh` tool can be used to access the {pmg} API via the command line.
93f5feff 29
38b7302f 30.Examples
93f5feff
DM
31
32List entries:
33
34----
35# pmgsh ls /
36----
37
f11e91b5 38Call the 'GET' method on a specific API path:
93f5feff
DM
39
40----
41# pmgsh get /version
42----
43
44View current mail configuration:
45
46----
47# pmgsh get /config/mail
48----
49
50Get help for a specific path:
51
52----
53# pmgsh help /config/mail -v
54----
55
56Disable option 'spf' in '/config/mail'
57
58----
59# pmgsh set /config/mail -spf 0
60----
61
e051eef8 62Delete 'spf' setting from '/config/mail'
93f5feff
DM
63
64----
65# pmgsh set /config/mail -delete spf
66----
67
68
69ifdef::manvolnum[]
70include::pmg-copyright.adoc[]
71endif::manvolnum[]
72