mirror of
https://git.proxmox.com/git/pmg-docs
synced 2025-08-03 05:04:27 +00:00
73 lines
900 B
Plaintext
73 lines
900 B
Plaintext
[[chapter_pmgsh]]
|
|
ifdef::manvolnum[]
|
|
pmgsh(1)
|
|
========
|
|
:pmg-toplevel:
|
|
|
|
NAME
|
|
----
|
|
|
|
pmgsh - Proxmox Mail Gateway API Shell
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
include::pmgsh.1-synopsis.adoc[]
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
endif::manvolnum[]
|
|
ifndef::manvolnum[]
|
|
pmgsh - API Shell
|
|
=================
|
|
:pmg-toplevel:
|
|
endif::manvolnum[]
|
|
|
|
The `pmgsh` tool can be used to access the {pmg} API via the command line.
|
|
|
|
.Examples
|
|
|
|
List entries:
|
|
|
|
----
|
|
# pmgsh ls /
|
|
----
|
|
|
|
Call method 'GET' on an specific API path:
|
|
|
|
----
|
|
# pmgsh get /version
|
|
----
|
|
|
|
View current mail configuration:
|
|
|
|
----
|
|
# pmgsh get /config/mail
|
|
----
|
|
|
|
Get help for a specific path:
|
|
|
|
----
|
|
# pmgsh help /config/mail -v
|
|
----
|
|
|
|
Disable option 'spf' in '/config/mail'
|
|
|
|
----
|
|
# pmgsh set /config/mail -spf 0
|
|
----
|
|
|
|
Delete 'spf' setting from '/config/mail'
|
|
|
|
----
|
|
# pmgsh set /config/mail -delete spf
|
|
----
|
|
|
|
|
|
ifdef::manvolnum[]
|
|
include::pmg-copyright.adoc[]
|
|
endif::manvolnum[]
|
|
|