Windows-based Hosting::CreateDNSZone

The CreateDNSZone procedure creates a zone on a specified DNS server.

Arguments

The CreateDNSZone procedure has the following input parameters.

Input Argument Description

<userName>

Authentication credentials for the target DNS server. Only required when using Basic Authentication to talk to the DNS Provider Client.

<password>

Authentication credentials for the target DNS server. Only required when using Basic Authentication to talk to the DNS Provider Client.

<serverIdentifier>

A string containing the IP address or fully qualified domain name (FQDN) of the DNS server.

<zoneName>

The name of the DNS zone to create, for example fabrikam.com.

<zoneType>

The type of the DNS zone to create, for example primary or secondary.

<org>

The Lightweight Directory Access Protocol (LDAP) path of the owning organization.

<preferredDomainController>

<commitFlag>

Values are: {COMMIT | <NOCOMMIT> }. Zones are created as PAUSED unless the CommitFlag is set.

<adminEmail>

A string containing the e-mail address of the administrator of the zone.

Dd279050.note(en-us,TechNet.10).gifNote
If you specify a value for adminEmail, the created value on the DNS server will have the domain name appended to the specified email address.

<debugLevel>/<@logging>

controls the level of detail provided [high | medium | low].

<properties>

  • <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.

<properties/property[@name="IpAddr"]>

The IP address of the master server when creating a secondary zone. This value is required for secondary zones but ignored for primary zones.

Output Arguments

The CreateDNSZone procedure has no return values.

Remarks

Security

The CreateDNSZone procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

The CreateDNSZone procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

Process Steps

The following step occurs when creating a DNS zone with the CreateDNSZone procedure of the Managed Windows-based Hosting Namespace:

  • Call DNS Provider:CreateDNSZone.

Sample Code

Example XML Request

The following is an example of an XML request for the CreateDNSZone procedure of the Managed Windows-based Hosting Namespace:

<request> 
        <data> 
                <org>LDAP://ou=WbHOrg2,ou=WbHReseller,ou=hosting, 
                dc=fabrikam,dc=com</org> 
                <preferredDomainController>AD01-WH.fabrikam.Com 
                </preferredDomainController> 
                <serverIdentifier>10.18.0.20</serverIdentifier> 
                <userName>fabrikam\administrator</userName> 
                <password>!Zam*ps1</password> 
                <zoneName>myDomain.com</zoneName> 
                <zoneType>primary</zoneType> 
                <adminEmail>admin@mydomain.com</adminEmail> 
                <commitFlag>COMMIT</commitFlag> 
                <debugLevel logging="high" check-only="on"/> 
        </data> 
        <procedure> 
                <execute namespace="Windows-based Hosting"  
                procedure="CreateDNSZone"> 
                        <before source="data" destination="executeData" mode="merge"/> 
                        <after source="executeData" destination="data" mode="insert"/> 
                </execute> 
        </procedure> 
</request> 
                

Applies To

Managed Windows-based Hosting Namespace API for:

  • 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

Windows-based Hosting::DeleteDNSZone