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