Check nsgroup

Purpose

The EPP <check> nsgroup command is used to determine if one or several objects can be provisioned within a repository. It provides a hint that allows a client to anticipate the success or failure of provisioning an object using the <create> command.

Specify one <nsgroup:name> element for every nsgroup that you want to check:

• <nsgroup:name> is required. Contains the name of the name server group.

Many nsgroup objects can be checked with a single check command.

Please refer to the examples to see a complete request.

Examples

A check nsgroup command for 2 objects looks like:

<?xml version="1.0" encoding="UTF-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:nsgroup="http://www.dns.be/xml/epp/nsgroup-1.0"
     xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd
             http://www.dns.be/xml/epp/nsgroup-1.0 nsgroup-1.0.xsd">
<command>
  <check>
    <nsgroup:check>
      <nsgroup:name>mynsgroup1</nsgroup:name>
      <nsgroup:name>mynsgroup2</nsgroup:name>
    </nsgroup:check>
  </check>
  <clTRID>clientref-00014</clTRID>
 </command>
</epp>

In case of success, the EPP server responds:

<?xml version="1.0" encoding="UTF-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:nsgroup="http://www.dns.be/xml/epp/nsgroup-1.0">
  <response>
    <result code="1000">
      <msg>Command completed successfully</msg>
    </result>
    <resData>
      <nsgroup:chkData>
        <nsgroup:cd>
          <nsgroup:name avail="false">mynsgroup1</nsgroup:name>
        </nsgroup:cd>
        <nsgroup:cd>
          <nsgroup:name avail="false">mynsgroup2</nsgroup:name>
        </nsgroup:cd>
      </nsgroup:chkData>
    </resData>
    <trID>
      <clTRID>clientref-00014</clTRID>
      <svTRID>dnsbe-0</svTRID>
    </trID>
  </response>
</epp>

The following information can be seen in the reply:

• <nsgroup:name> Contains the name of the nsgroup that was checked. The ‘avail’ attribute contains a value of ‘false’ if the nsgroup is not available, a value of ‘true’ if the nsgroup is available, at the time of the check.

There is an entry in the command for each of the name server groups that were checked.