DNS Provider::CreateDNSZone

  • Article

The CreateDNSZone procedure allows you to create a requested zone on a specified server. This method does not update any secondary servers.

Note

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

Note

Zone files are not actually created unless the CommitFlag is set. Creating zones is a multi-step process and zones are not valid until many of the steps are successfully completed. The default value of the CommitFlag, NOCOMMIT, allows for rapid completion of those steps prior to making the zone public, which also avoids having partially valid zone files on the server. After all of the characterization steps are completed, the WriteBackZoneFile method is called and the zone can be un-PAUSED.

Arguments

Input argument Required Description

ServerIdentifier

Yes

A string containing the dotted-quad Internet Protocol (IP) address or the fully qualified domain name (FQDN) of the server.

  • {Credentials} - Optional authentication credentials for the target DNS server.

ZoneName

Yes

A string containing the FQDN of the zone.

ZoneType

Yes

Values are: { PRIMARY | SECONDARY | FORWARD }.

  • {AdminEmail} - A string containing the e-mail address of the administrator of the zone.

  • {CommitFlag} - Values are: { COMMIT | <NOCOMMIT> }.

  • {DebugLevel} - A string to control tracing and other debugging functionality. Values are: Logging = { HIGH | MEDIUM | LOW } Check-only = { ON | OFF }

PropertyTree

Yes
  • {IPAddr} - A required string containing the dotted-quad IP address of the authoritative server, if this zone is a secondary zone. This string is optional and ignored in other cases.

  • {DataFile} - Optional name for zone file. Acceptable only if the default NOCOMMIT is explicitly overridden. The actual file name may be different for various reasons.

  • {SecondaryServers} - An array of strings that enumerate the IP addresses of DNS servers allowed to receive this zone through zone replication.
Output argument Description

OperationStatus

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

ZoneFileName

A string containing the distinguished name of the zone file. Empty if no zone file exists yet. Returns the actual name used for the zone file, regardless of the suggestion, and regardless of the CommitFlag setting.

Remarks

For the CreateDNSZone method, the following conditions apply:

  • Active Directory directory service integrated zones are not supported.

  • In the event of a failure, any zone files that were partially created will be deleted.

  • Zones are created as PAUSED unless the CommitFlag is set.

Sample Code

Example XML Request

<?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> 
 
           <zoneType>primary</zoneType> 
 
                <adminEmail>admin@mydomain.com</adminEmail> 
 
         <commitFlag>COMMIT</commitFlag> 
 
             <debugLevel logging="high" check-only="on"/> 
 
              <properties> 
 
                      <property name="IpAddr"></property> 
 
                 <property name="DataFile">mydomain.com.dns</property> 
 
                       <property name="SecondaryServers"> 
 
                                <value>100.100.100.10</value> 
 
                       </property> 
 
               </properties> 
 
     </data> 
 
   <procedure> 
 
               <execute namespace="DNS Provider" procedure="CreateDNSZone"> 
 
                      <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 CreateDNSZone method of the DNS Provider:

<?xml version="1.0" encoding="iso-8859-1" ?> 
    <response> 
 
                <data> 
 
                    <operationStatus>Success</operationStatus> 
 
                  <zoneFileName>c:\winnt\system32\dns\mydomain.com.dns</zoneFileName> 
 
 </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::ModifyDNSZone
DNS Provider::DeleteDNSZone
DNS Provider::GetDNSZone