User Tools

Site Tools


api:export:externalsystempleskautodns

ExportAPI: Destination Plesk Automation (DNS-Records)

This destination adds DNS A-records for yourCMDB objects to a given DNS zone in Plesk Automation using the Plesk Automation XML RPC API. Any existing A records in that zone, that does not exists as objects in yourCMDB will be deleted. You can manage other record types like CNAME or MX records manually in that zone and the yourCMDB exporter will not touch these records.

To use this exporter, you have to enable the Plesk Automation XML RPC API. Please have a look in this guide to get started: http://download1.parallels.com/ppa/11.5/docs/en-US/online/ppa_integration_guide/

The exporter will not create a DNS zone for you. So the DNS zone should already exist, if you want to use this exporter.

Configuration

short information
class name ExternalSystemPleskAutoDns
needed destination parameterpleskApiUrl
pleskApiUser
pleskApiPassword
domainName
needed variableshostname
ip

destination parameters

namerequireddescriptionexample
pleskApiUrlrequiredXML RPC API URL of your Plesk Automation systemhttp://127.0.0.1:8440/RPC2
pleskApiUserrequiredXML RPC API usernameadmin
pleskApiPasswordrequiredXML RPC API passwordadmin
domainNamerequiredDNS Zone managed by Plesk Automation for adding DNS A recordsobjects.yourcmdb.org
pleskApiSslVerifyoptionaldisable SSL peer verificationfalse

variables

namerequireddescriptionexample
hostnamerequiredhost part of the DNS A recordtest
iprequiredip address of the DNS A record8.8.8.8

Examples

example of export task configuration:

<task name="pleskdns-example">
              <sources>
                      <source objecttype="router" status="A" />
                      <source objecttype="switch" status="A" />
              </sources>
              <destination class="ExternalSystemPleskAutoDns">
                      <parameter key="pleskApiUrl" value="http://127.0.0.1:8440/RPC2" />
                      <parameter key="pleskApiUser" value="admin" />
                      <parameter key="pleskApiPassword" value="admin" />
                      <parameter key="domainName" value="objects.yourcmdb.org" />
              </destination>
              <variables>
                      <variable name="hostname">
                              <value objecttype="router" fieldname="hostname" />
                              <value objecttype="switch" fieldname="hostname" />
                      </variable>
                      <variable name="ip">
                              <value objecttype="router" fieldname="management-ip" />
                              <value objecttype="switch" fieldname="management-ip" />
                      </variable>
              </variables>
</task>
api/export/externalsystempleskautodns.txt · Last modified: 2017/07/24 11:43 (external edit)