DNS Provider::ResumeDNSZone

  • Article

The ResumeDNSZone procedure allows you to restore a requested zone to service on a specified server, if it was paused. If it was not paused, the operation succeeds anyway.

Note

Before using this procedure, security must be carfully considered. For detailed information about MPS DNS provider security, see DNS Provider Architecture.

Arguments

Input argument Required Description

ServerIdentifier

Yes

A string containing the dotted-quad IP address or the Fully Qualified Domain Nname (FQDN) of the server.

API Name [HMC SDK]

No

Optional authentication credentials for the target DNS server.

ZoneName

Yes

A string containing the FQDN of the zone.

{DebugLevel}

No

A string to control tracing and other debugging functionality. Values are:

  • Logging = { HIGH | MEDIUM | LOW }

  • Check-only = { ON | OFF }
Output argument Description

OperationStatus

A string containing a success/failure indication, any error messages, and input parameter validity flags.

ZoneWasModifed

Returns TRUE if the zone was modified by MPS since the last unpaired PAUSE-RESUME; otherwise returns FALSE.

Remarks

For the ResumeDNSZone method, the following conditions apply:

  • If the server is primary for the indicated zone and the zone-modified flag (in the provider) was set, the zone is reset. ZoneWasModifed is then returned as TRUE.

  • If the server is secondary for the indicated zone, any zone updates that occurred while PAUSED are lost.

Sample Code

Example XML Request

Following is an example of an XML request for the ResumeDNSZone method of the DNS Provider:

<?xml version="1.0" encoding="iso-8859-1" ?> 
<request> 
 
  <data> 
 
            <serverIdentifier>100.100.100.125</serverIdentifier> 
 
                <userName>myuser</userName> 
 
         <password>password</password> 
 
               <zoneName>mydomain.com</zoneName> 
 
           <debugLevel logging="high" check-only="on"/> 
 
      </data> 
 
   <procedure> 
 
               <execute namespace="DNS Provider" procedure="ResumeDNSZone"> 
 
                      <before source="data" destination="executeData" mode="merge"/> 
 
                    <before source="executeData" destination="data" mode="insert"/> 
 
           </execute> 
 
        </procedure> 
 
</request>

Example XML Response

Following is an example of an XML response for the ResumeDNSZone method of the DNS Provider:

<?xml version="1.0" encoding="iso-8859-1" ?> 
<response> 
 
  <data> 
 
            <operationStatus>Success</operationStatus> 
 
          <zoneWasModified>False</zoneWasModified> 
 
    </data> 
 
</response>

Applies To

DNS Provider API for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

DNS Provider::PauseDNSZone
DNS Provider::ReloadDNSZone
DNS Provider::RefreshDNSZone