WebDNS extensions to the FreeVSD protocol
Author: Nick Burrett <nick@dsvr.net>
Last updated: 15 September 2000


Protocol description
====================

Domain zone files are stored on the name server in
/var/named/<virtual server>/{a-z}/dns/ and are therefore associated with a
particular virtual server name.

BIND_LIST
   Description:
     List all domains on the name server that belong to <virtual server>

   Output:
     A line-feed seperated list of domain names.

BIND_DELETE <domain name>
   Description:
     Delete domain <domain name> that belongs to <virtual server>

   Output:
     Nothing.

BIND_GET <domain name>
   Description:
     Retrieve the zone file details for domain <domain name> associated
     with <virtual server>

   Output:
     A new-line seperated list of resource records

BIND_ADD <domain> <ip>
   Description:
     Add the domain <domain> to the primary name server. Use the IP address
     <ip> for the address records. <primary ns> and <secondary ns> specify
     the primary and secondary name servers that serve this domain.

   Output:
     Nothing.

BIND_MODIFY <domain> {
<script>
}
   Description:
     Modify the resource records of <domain> associated with <virtual-server>

   Input:
     The <script> should consist of one, or more lines of the following form,
     seperated by newlines:
       add <origin> <class> <type> <server> [<rr specific params>]
       delete <origin> <class> <type> <server> [<rr specific params>]
       replace <origin> <class> <type> <server> [<rr specific params>]

     `add' - add a new resource record to the end of the zone file
     `delete' - delete a resource record from the zone file
     `replace' - replace a resource record in the zone file, deleting
                 one RR and adding a new one in the same position within the
		 zone file.  For this to work, `replace' must be immediately
		 followed by an `add' command. 

   Output:
     Nothing.

   Example:
     BIND_MODIFY foobar.co.uk {
     add cvs IN CNAME www
     delete mail IN CNAME www
     add blah IN MX 5 192.168.94.22
     }
     

BIND_IPMOD <domain> <old ip> <new ip>
   Description:
     Modify a domain, replacing occurrences of the IP address <old ip> with
     the IP address <new ip>.

   Output:
     Nothing.


BIND_NAMEDGEN
   Description:
     Re-generate named.conf

   Output:
     Nothing.

BIND_SETTTL <ttl>
   Description:
     Set the Time To Live of all domains to <ttl> seconds.  This command
     will automatically reload the changed domains into the name server.

     This command is only really useful when upgrading VS accounts.

   Output:
     Nothing.

BIND_RELOAD
    Description:
      Reload all domains that belong to a virtual server in the name server.
      You would use this command on the secondary name server after making
      a large set of changes to the primary, such as changing the IP address
      or setting the TTL.

    Output:
      Nothing.


The following commands are only accessible through the `<root>' virtual
server.


BIND_IPMODALL <virtual server> <old ip> <new ip>
   Description:
     Modify all domain associated with a virtual server, replacing occurrences
     of the IP address <old> with the IP address <new>.

     You should probably be using BIND_RENAMEVS rather than this command.

   Output:
     Nothing.

BIND_FIX <virtual server> <domain>
   Description:
     Fix common errors in a zone file called <domain>.

     It is unlikely that you would use this command.

   Output:
     Nothing.

BIND_FIXALL <virtual-server>
   Description:
     Fix common errors in all zone files associated with a virtual server.

     It is unlikely that you would use this command.

   Output:
     Nothing.

BIND_DBGEN
   Description:
     Regenerate the domain database.  This database is used to stop
     users adding a domain to the name servers multiple times under
     different virtual server accounts.

   Output:
     Nothing.

BIND_DBLIST
   Description:
     List domains stored in the exclusion database.  Note: this is not
     the same database as that generated by BIND_DBGEN.

   Output:
     A line-feed seperated list of domain names.

BIND_DBADD <domain-name>
   Description:
     Add a domain name to the exclusion database.

   Output:
     Nothing.

BIND_DBDELETE <domain-name>
   Description:
     Delete a domain name from the exclusion database.

   Output:
     Nothing.

BIND_ADDVS <virtual server> <ip> <max domains> [<primary ns>] [<secondary ns>]
   Description:
     Register <virtual-server> for access to the name servers.  Allow it
     to add <max-domains>.  If <max-domains> is 0 then there are no limits
     on the number of domains that can be added.

     If the account has it's own name servers then these can be optionally
     given as <primary-ns> and <secondary-ns>.

   Output:
     Nothing.

BIND_DELETEVS <virtual server>
   Description:
     Delete a virtual server

   Output:
     Nothing.

BIND_RENAMEVS <old-vs> <new-vs> <old-ip> <new-ip>
   Description:
     Rename a virtual server from <old-vs> to <new-vs>.  Optionally we
     can change the IP address of all domains in the virtual server
     directory from <old-ip> to <new-ip>.

     All four parameters must be supplied. If we want to change only the
     virtual server name then ensure <old-ip> == <new-ip>.  Likewise
     if we only want to change the IP addresses for the domains then
     ensure <old-vs> == <new-vs>.

   Output:
     Nothing.


BIND_ROOTNAMEDGEN
   Description:
     Re-generate main named.conf index.

   Output:
     Nothing.

BIND_SETQUOTA <vs> <domain-count>
   Description:
     It is possible to set a restriction on a per-virtual server basis
     concerning the number of domains that can be entered into the name
     servers.  This command will set the upper limit of virtual server <vs>
     to <domain-count> domains.

   Output:
     Nothing.


ChangeLog
=========

08-Apr-20001
   Changed all instances of WEBDNS to BIND, in accordance of code changes.

15-Sep-2000
   Add description of BIND_SETQUOTA, BIND_SETTTL, BIND_RELOAD.
   Add IP argument to BIND_ADDVS.