DNS Provider::PauseDNSZone

  • Article

The PauseDNSZone procedure allows you to temporarily remove a requested zone on a specified server from service.

Note

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

Arguments

Argument Required Description

ServerIdentifier

Yes

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

{Credentials}

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.

Remarks

For the PauseDNSZone method, the following conditions apply:

  • No DNS requests for the indicated zone will be answered while the zone is paused.

  • No zone-push or notify operations will be accepted or attempted while the zone is PAUSED, although a zone-modified flag is kept in the provider. No zone-push or notify operations will be accepted or attempted while the zone is PAUSED, although a zone-modified flag is kept in the provider. If the modified zone is a primary zone, the queued notifications will be initiated once the zone is RESUMED.

Sample Code

Example XML Request

The following is an example of an XML request for the PauseDNSZone 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="PauseDNSZone"> 
 
                       <before source="data" destination="executeData" mode="merge"/> 
 
                    <before source="executeData" destination="data" mode="insert"/> 
 
           </execute> 
 
        </procedure> 
 
</request>

Example XML Response

The following is an example of an XML response for the PauseDNSZone method of the DNS Provider:

<?xml version="1.0" encoding="iso-8859-1" ?> 
<response> 
 
     <data> 
 
            <operationStatus>Success</operationStatus> 
 
  </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::ResumeDNSZone
DNS Provider::ReloadDNSZone
DNS Provider::RefreshDNSZone