Note
This document will be updated as the DMS protocol is implemented.
The Python plug in protocol is WSGI, very similar to Fast CGI, and the wire communications is JSON RPC over http/https
The server to be tightly coded to a standard so it behaves reasonably. Clients won’t have to be so fussy, but should not request anything they are not coded to deal with! Comprehensive error processing by the client is encouraged.
The protocol will be JSON-RPC over HTTP 1.1+. This will enable the processing of multiple requests over the same TCP connection. TCP connections to the server will be cacheable, and can be held open up to a limit set on the server. Multiple POSTs over the connection are allowed, and multiple RPC requests can be submitted within a POST request, with the id: set to a UUID string generated as per RFC 4122.
JSON/RPC 2.0 specification will be used. JSON RFC 4627 will be used as the data format.
JSON-RPC over HTTP will be used to access the server, with the limitation being that HTTP POST shall be used, not GET with its encoded URL.... (blech!). Batch mode requests will also be implemented.
Authentication will be via HTTP Basic authentication, with the deployed implementation using HTTPS for integrity. Privileged access stratification will be achieved by accessing different Python WSGI scripts at different URLs. Initially 2 different levels of access will be provided:
Comprehensive administrative functionality will be available via the zone-tool command line UI on the Master DNS server.
Errors shall be python exceptions translated to JSON-RPC errors. The ‘data’ section will contain relevant exception attributes, along with an error message. There will different classes of error, dependent on the operation being performed.
Errors to do with Zone Instance submission will return RR Group and RRS index information into the ZI structure sent in the request.
Please not that zones outside the client role are treated as if they do not exist unless otherwise noted.
Please see DMS Errors for a full listing.
Please note that an edit cycle starts with the edit_zone call below, and is finished with an update_zone call. When edit locking is enabled for the zone (typically only hel pdesk, admin, and special customers) the tickle_editlock (keep a locked editing session live, called on receiving any data from web browser) and ‘cancel_edit_zone’ (to cancel edit session) calls should be used.
The update_rrs call is to be used for incremental updates. The update_type is a unique ID identifying the operation type, of which only one per zone can be queued at a time. Each update call eventually generates a new ZI incorporating the changes after the call returns. When the call is made, a forward-looking check is made with the current (or candidate) ZI to make sure the changes to be made are consistent.
This mechanism is only for the simple consistent changes required for adding/removing a Web site to a domain, adding/removing mail MX records for adding Web hosting or Mail to a domain.
Note
The error checking is forward looking and would probably fail to produce a published zone for complex change sets. It is NOT for making general editing changes such as these to the zone. Use the i:ref:Editing-Cycle above for user UI editing sessions, not this.
Errors are exceptions in dms.exceptions, as listed below
list_zone(names, [reference], [include_deleted], [toggle_deleted], [include_disabled])
array of wildcard-names
customer ID or other ID meta data
boolean true/false whether to include deleted domains in listing
boolean true/false list only deleted domains
boolean true/false include disabled domains, defaults to true
To list domains. Many wild carded domains can be specified. Response will either be the list of domain names, or an empty list as domains cannot be found. Customer facing DMIs will be set up so that a ZoneSearchPatternError exception will be thrown if list_zone is called with no names, or names set to *, without reference being given.
.._rpccall_list_zi:
list_zi()
list_zi(name)
domain to list
List all zis for a domain. Returns just the base zone_sm object, and the list of zis all_zis. The published zi is the zi in the zone_sm object, and its full structure is returned, Each zi is accompanied by its ctime and mtime. The output is shown below in show_zone().
show_zone(name, [zi_id])
show_zone_text(name, [zi_id], [all_rrs])
domain to show.
optional zone instance
optional NOT showing of Apex RRs. Only for show_zone_text
Like the previous operation, except that the full zi returned can be given.
show_zone_text() returns a zone file text blob, JSON encoded. Note that this means new line, tab, etc are encoded as ‘n’, ‘t’ not as a control characters.
Sample JSON dump of output of show_zone. Note that “sectags” sub-array only shows up in Admin DMS client RPC interface:
{ 'all_zis': [ {
'ctime': 'Mon Mar 5 14:11:25 2012',
'mtime': 'Mon Mar 5 14:46:21 2012',
'ptime': 'Mon Mar 5 14:46:21 2012',
'zi_id': 45,
'zone_id': 32}],
'alt_sg_name': null,
'auto_dnssec': false,
'ctime': 'Mon Mar 5 14:11:25 2012',
'deleted_start': null,
'edit_lock': false,
'edit_lock_token': null,
'inc_updates': false,
'lock_state': 'EDIT_UNLOCK',
'mtime': 'Mon Mar 5 14:11:25 2012',
'name': 'anathoth.net.',
'nsec3': false,
'reference': 'net24',
'sectags': [{'sectag_label': 'Admin'}],
'soa_serial': 2012030500,
'sg_name': 'net24-one',
'state': 'PUBLISHED',
'use_apex_ns': true,
'zi': { 'ctime': 'Mon Mar 5 14:11:25 2012',
'mtime': 'Mon Mar 5 14:46:21 2012',
'ptime': 'Mon Mar 5 14:46:21 2012',
'rr_groups': [ { 'comment': 'Apex resource records for anathoth.net.',
'rrs': [ { 'class': 'IN',
'disable': false,
'label': '@',
'lock_ptr': false,
'rdata': 'ns2.anathoth.net.',
'reference': null,
'rr_id': 5126,
'ttl': null,
'type': 'NS',
'zi_id': 45},
{ 'class': 'IN',
'disable': false,
'label': '@',
'lock_ptr': false,
'rdata': 'ns1i.anathoth.net.',
'reference': null,
'rr_id': 5125,
'ttl': null,
'type': 'NS',
'zi_id': 45},
{ 'class': 'IN',
'disable': false,
'label': '@',
'lock_ptr': false,
'rdata': 'ns1.anathoth.net. soa.net24.net.nz. 2012030500 7200 7200 604800 86400',
'reference': null,
'rr_id': 5124,
'ttl': null,
'type': 'SOA',
'zi_id': 45}],
'tag': 'APEX_RRS'}],
'soa_expire': '7d',
'soa_minimum': '24h',
'soa_mname': 'ns1.net24.net.nz.',
'soa_refresh': '7200',
'soa_retry': '7200',
'soa_rname': 'soa.net24.net.nz.',
'soa_serial': 2012030500,
'soa_ttl': null,
'zi_id': 45,
'zone_id': 32,
'zone_ttl': '24h'},
'zi_candidate_id': 45,
'zi_id': 45,
'zone_id': 32,
'zone_type': 'DynDNSZoneSM'}
create_zone(<name> <reference> <login_id> [zi_data] [sectags] [sg_name] [edit_lock] [auto_dnssec] [nesc3] [inc_updates] )
create_zone(<name> <reference> <login_id>)
copy_zone(<src_name> <name> <reference> <login_id> [zi_id] [sectags] [sg_name] [edit_lock] [auto_dnssec] [nesc3] [inc_updates]
source domain to be copied
source ZI to be copied
domain to be created
reference for domain being created - can be missed, but domain will be owned by default_ref, ie RESELLER-NZ
DMI login ID. Email address, or numerical login_id
optional zi_data (for feeding in a template)
optional sg where zone is to be created Admin DMS only.
optional list of security tags for new zone. Admin DMS only. Same array/object format as listing above.
optional boolean for turning on edit_lock mode, default false
optional boolean for turning on automatic DNSSEC, default false
optional boolean for enabling NSEC3 under DNSSEC, default false
optional boolean for enabling incremental updates for zone, default true for basic interface, false for help desk and admin interfaces.
Returns true
Errors are returned if a zone already exists. Optional zi_data in the format above can be feed in for a template. Please note that Apex SOA and NS records will not be taken. Basic call used by default for reseller websites and ISP DNS front ends
enable_zone(<name>)
domain to be enabled.
Returns true
Errors will be returned if the zone does not exist.
disable_zone(<name>)
domain to be enabled.
Returns true
Errors will be returned if the zone does not exist.
delete_zone(<name>)
domain to be enabled.
Returns true
Errors will be returned if the zone does not exist.
set_zone(<name> [edit_lock] [auto_dnssec] [nsec3] [inc_updates])
domain to be created
optional boolean for turning on edit_lock mode, default false
optional boolean for turning on automatic DNSSEC, default false
optional boolean for enabling NSEC3 under DNSSEC, default false
optional boolean for enabling incremental updates for zone, default true for basic interface, false for help desk and admin interfaces.
Returns true
Errors are returned if a zone already exists.
undelete_zone(<zone_id>)
Id of deleted zone to be undeleted
Returns true
Undelete a zone.. This can only be done to a deleted zone, and if there are no active zones with the same name.
destroy_zone(<zone_id>)
Id of deleted zone to be destroyed
Returns true
Destroy a zone.. This can only be done to a deleted zone.
copy_zi(<src_name>, <name>, [zi_id])
Source zone name
destination domain name
DMI login ID. Email address, or numerical login_id
ZI ID to be copied, default published ZI of source zone.
Returns true
Copy a ZI from a source zone to another.
delete_zi(<name> <zi_id>)
domain name
ZI ID
Delete a zi. This can only be done for a ZI that is not currently in use.
edit_zone(<name> <login_id> [zi_id])
domain to be edited.
optional zone-instance number or Null
Returns: list (zone_zi_data, edit_lock_token).
Can be: [zi_data, edit_lock_token] if edit_lock obtained.
[zi_data, Null] if zone does not have edit locking enabled.
Errors are returned if the zone does not exist, zi_id is invalid, an edit_lock is not able to be obtained.
Returns a zone structure, with a list of all zis in database for domain, accompanied by the zi’s date. This structure is the one show above for show_zone().
The zi structure contains all the SOA data. Depending on the value of use_apex_ns, for True the Apex NS records are supplied, and the secondary DNS server parameters of the SOA record are set-able. Otherwise, the Apex NS records are not supplied as they are the global DNS secondary server settings, and the only editable SOA fields (always editable) are soa_minimum, soa_ttl, and zone_ttl. Dmsdmd always generates the SOA record for a zone from the values in the zi structure, and automatically calculates the zone SOA serial number based on the algorithm used in the RFCs(RFC 2316 Sec 3.4.2.2, RFC 1982 Section 3) and conventional serial number guidelines based on the date, if it is possible.
The zi_id parameter defaults to the published ZI, and another ZI can be given. The edit lock is an optional feature zone state machine that can be enabled from zone-tool for domains the are often edited, to prevent unpredictable updates to published zones (Ie 2 people editing server.isp.net simultaneously, and then one having his changes wiped out by the later publish action). The edit lock is covered by an inactivity timeout which is reset by the tickle_editlock() method.
tickle_editlock(<name>, <edit_lock_token>)
domain being edited
edit lock token to be tickled
Notification of UI activity to reset edit lock time out.
cancel_edit_zone(<name>, <edit_lock_token>)
domain being edited
edit lock token to be canceled
Cancels a locked zone editing session.
update_zone(<name>, <zi_data>, <login_id>, [edit_lock_token])
domain to be updated
new zi structure to be published.
DMI login_id. Email format, or numerical string.
Must be supplied to finish an edit locked session.
Saves zi_data to database for a zone. Queues a ZoneSMEditUpdate (edit_locked zone event) or ZoneSMUpdate event to publish domain with new zi.
show_sectags()
List all possible security tags. This command is only available with Admin level DMS client privilege. Sectags are created and deleted from the one_tool command line. Each WSGI back end has its privilege assigned by configuring it with a given security tag.
show_zone_sectags(<name>)
domain to be queried.
List the security attached to the given zone. This command is only available with Admin level DMS client privilege.
add_zone_sectag(<name>, <sectag>)
domain
sectag to be added
Returns true
Adds a sectag to a zone. Admin Level DMS client privilege only.
delete_zone_sectag(<name>, <sectag>):
domain
sectag to be deleted
Returns true
Deletes a sectag from a zone. Admin Level DMS client privilege only.
replace_zone_sectags(<name>, <sectags>)
domain to be operated on
list of sectags as per above format in listing.
Completely replaces the zones current sectags with the ones specified in the list. This command is only available with Admin level DMS client privilege.
Thus you can use show_sectags() to get all possible sectags, show_zone_sectags() to fill out check boxes in a dialogue/list, and then call replace_zone_sectags() with all checked values when user clicks <OK>/submits in Web UI.
sign_zone(<name>)
domain to be operated on.
Returns true
Resign a DNSSEC zone.
load_keys(<name>)
domain to be operated on.
Returns true
Load the DNSSEC keys for a zone.
refresh_zone(<name>)
domain to be refreshed.
Returns true
Refresh/update the contents of a zone from the DB into the DNS. Issues a publish event to zone.
reset_zone(<name>)
domain to be reset
Returns true
Resets the zone state machine. Useful for when dmsdmd has an internal error, or when named is mis-configured for write access.
refresh_zone_ttl(<name> [zone_ttl])
domain name of zone
named TTL string
Returns true
Refresh a zones TTL, using the global default for zone creation if none given.
show_configsm()
Returns true
Show the current status of the master named configuration state machine. Useful as it show when the next rndc config can happen.
create_reference(<reference>)
entity reference string
Returns true
Creates an entity reference string in the DMS for use with a set of zones.
delete_reference(<reference>)
entity reference string
Returns true
Deletes an unused entity reference string from the DMS when there are no more zones against it.
rename_reference(<reference> <dst_reference>)
original entity reference string
new entity reference string
Returns true
Rename a reference in the DMS. This should check with the user first to see if they really want to do this. I can see someone like Mike wanting to use this from DMI if the ID in the DMS zone database is wrong, if it is an account ID.
list_reference([reference-wildcard], [<reference-wildcard], ...)
reference wildcard string.
Returns list of references in JSON.
Lists references. Help desk and admin level functionality.
set_zone_reference(<name>, <reference>)
domain to be operated on
reference to be set on domain
Returns true
Change the reference on a domain. Again Admin level only functionality.
rr_query_db(<label> [name] [type] [rdata] [zi_id] [show_all])
host name or other DNS label
domain to be queried
RR type
RR rdata string
ZI ID
boolean rue/false, show all records, including disabled ones.
Query the DB ala the OS libc/libresolv hostname() call. This uses a cross zone DB query looking for any records. This is Admin level only functionality.
update_rrs(<name> <update_data> <update_type> <login_id>)
domain being updated
update data for zone
client update type
Email format, or numerical string.
Do incremental updates on a zone. The update data is the same ZI data format as in create_zone()
Example update file from equiv zone_tool update_rrs command:
$ORIGIN foo.bar.org.
$UPDATE_TYPE SpannerReplacement_ShouldBeUUIDperClientOpType
;!RROP:DELETE
ns5 IN ANY "" ; All records for ns5
;!RROP:DELETE
ns7 IN A "" ; All A records for ns2
;!RROP:DELETE
ns67 IN A 192.168.2.3 ; Specific record
;!RROP:ADD
ns99 IN TXT "Does not know Maxwell Smart"
;!RROP:ADD
ns99 IN AAAA 2002:fac::1
;!RROP:UPDATE_RRTYPE
ns99 IN AAAA ::1
The ZI data RRs are augmented with the update_op property, which takes the RROP text values of ADD, DELETE, and UPDATE_RRTYPE. As seen above the DELETE update_op can use RR type ANY, and blank rdata as wildcards. UPDATE_RRTYPE replaces all records of that type for the DNS zone node concerned.
The update_type property is used to make sure that only one update_type is queued per zone for execution. Each update is a unique transaction for the zone concerned.
Note that their are separate privilege levels for the Admin, help desk, and ordinary customer front ends, and these can affect the auto reverse parameters that can be used in the call, exactly the same as for update_zone()/create_zone() above.
Example of the JSON params object feed to the update_rrs() call:
{ 'name': 'foo.bar.org.',
'update_data': { 'rr_groups': [ { 'rrs': [
{ 'class': 'IN',
'disable': false,
'force_reverse': false,
'label': 'ns5.foo.bar.org.',
'lock_ptr': false,
'rdata': null,
'reference': null,
'type': 'ANY',
'update_op': 'DELETE'},
{ 'class': 'IN',
'disable': false,
'force_reverse': false,
'label': 'ns7.foo.bar.org.',
'lock_ptr': false,
'rdata': null,
'reference': null,
'type': 'A',
'update_op': 'DELETE'},
{ 'class': 'IN',
'disable': false,
'force_reverse': false,
'label': 'ns67.foo.bar.org.',
'lock_ptr': false,
'rdata': '192.168.2.3',
'reference': null,
'type': 'A',
'update_op': 'DELETE'}]},
{ 'rrs': [
{ 'class': 'IN',
'disable': false,
'force_reverse': false,
'label': 'ns99.foo.bar.org.',
'lock_ptr': false,
'rdata': '"Does not know Maxwell Smart"',
'reference': null,
'type': 'TXT',
'update_op': 'ADD'},
{ 'class': 'IN',
'disable': false,
'force_reverse': false,
'label': 'ns99.foo.bar.org.',
'lock_ptr': false,
'rdata': '2002:fac::1',
'reference': null,
'type': 'AAAA',
'update_op': 'ADD'}]},
{ 'rrs': [
{ 'class': 'IN',
'disable': false,
'force_reverse': false,
'label': 'ns99.foo.bar.org.',
'lock_ptr': false,
'rdata': '::1',
'reference': null,
'type': 'AAAA',
'update_op': 'UPDATE_RRTYPE'}
]}
]},
'update_type': 'SpannerReplacement_ShouldBeUUIDperClientOpType'}
set_zone_sg(<name>, <sg_name>)
domain to be operated on.
sg the zone is being moved to.
Returns true
Set the SG a zone is served on. Note that this call at present can only be used on disabled zones. Admin level only call.
set_zone_alt_sg(<name>, <sg_name>)
domain to be operated on.
Alternate sg the zone is being served on.
Returns true
Set an additional SG a zone will be served on. Note that this call at present can only be used on disabled zones. Note that the SG concerned has to be refreshed. Admin level only call.
list_sg()
Returns list of SGs in JSON format
List all SGs that are existent on the master DNS server. Admin level only call, for populating menu drop boxes when creating zones etc.
Exceptions module for the DMS
Bases: dms.exceptions.ZoneSmFailure
Another zone instance is active - this one cannot be activated.
JSONRPC Error: -69
Bases: dms.exceptions.PrivilegeNeeded
Administrative privilege is needed to set this RR field
JSONRPC Error: -26
Bases: dms.exceptions.DMSError
Name of the Zone can not be determined.
JSONRPC Error: -55
Bases: dms.exceptions.ZoneParseError
Owner name of an A AAAA or MX record is not a valid hostname
JSONRPC Error: -13
Bases: dms.exceptions.ZoneParseError
Name in the rdata of a record is not a valid hostname
JSONRPC Error: -14
Bases: dms.exceptions.DMSError
Trying to load a binary file.
JSONRPC Error: -39
Bases: dms.exceptions.ZoneSmFailure
For a DMI, can’t clear edit_lock for zone.
JSONRPC Error: -33
Bases: dms.exceptions.DMSError
For an event_id, can’t fail the event because it is processed or already failed.
JSONRPC Error: -130
Bases: dms.exceptions.DMSError
Configuration SM Failed to enter CONFIG_HOLD for batch zone creation
Bases: dms.exceptions.DMSError
Database is in Read Only mode.
JSONRPC Error: - 122
Bases: magcode.core.wsgi.jsonrpc_server.BaseJsonRpcError
Base DMS Error Exception
Bases: dms.exceptions.RestoreNamedDbError
Dmsdmd is still running
JSONRPC Error: -109
Bases: dms.exceptions.ZoneError
Zone already has a record for this.
JSONRPC Error: -20
Bases: dms.exceptions.DynDNSUpdateError
Can’t read in configured TSIG for Dynamic DNS update
JSONRPC Error: -5
Bases: dms.exceptions.UpdateError
Error during update of zone
JSONRPC Error: -4
Bases: dms.exceptions.ZoneSmFailure
For a DMI, can’t obtain an edit_lock for zone.
JSONRPC Error: -34
Bases: dms.exceptions.DMSError
For an event_id, an event is not found
JSONRPC Error: -129
Bases: dms.exceptions.ZoneParseError
Our zone parser does not support the $GENERATE statement
JSONRPC Error: -54
Bases: dms.exceptions.PrivilegeNeeded
Help desk privilege is needed to set this RR field
JSONRPC Error: -27
Bases: dms.exceptions.DirectiveParseError
Hostname parse error while parsing zone file.
JSONRPC Error: -51
Bases: dms.exceptions.ZiParseError
Zi related SOA mname or rname value error.
JSONRPC Error: -48
Bases: dms.exceptions.ZoneParseError
Our zone parser does not support the $INCLUDE statement
JSONRPC Error: -50
Bases: dms.exceptions.DMSError
Error in Incremental Update mechanism. Update mechanism not in Trial Run Mode.
JSONRPC Error: JSON_RPC_INTERNAL_ERROR
Bases: dms.exceptions.DMSError
Incremental Updates are disabled for this zone.
JSONRPC Error: -90
Bases: dms.exceptions.DMSError
Domain name is invalid.
JSONRPC Error: -89
Bases: dms.exceptions.DMSError
Invalid Hmac type given
JSONRPC Error: -96
Bases: dms.exceptions.ZoneParseError
RR type is one we don’t handle.
JSONRPC Error: -83
Bases: dms.exceptions.ZoneParseError
FQDN Label outside of domain
JSONRPC Error: -12
Bases: dms.exceptions.DMSError
DMS Error class to cover login_id exceptions
Bases: dms.exceptions.LoginIdError
A login_id can only consist of the characters ‘-_a-zA-Z0-9.@’, and must start with a letter or numeral. It also must be less than 512 characters long.
JSONRPC Error: -124
Bases: dms.exceptions.LoginIdError
A login_id must be given, and be less than 512 characters long.
JSONRPC Error: -125
Bases: dms.exceptions.DMSError
Multiple references were found
JSONRPC Error: -68
Bases: dms.exceptions.RestoreNamedDbError
Can’t write named.conf sections
JSONRPC Error: -113
Bases: dms.exceptions.RestoreNamedDbError
Named is still running
JSONRPC Error: -108
Bases: dms.exceptions.DMSError
No Previous Label seen. - This should not be reached in code
JSONRPC Error: -7
Bases: dms.exceptions.DMSError
No Reference found.
JSONRPC Error: -67
Bases: dms.exceptions.DMSError
For a DMI, Master SG not found
Bases: dms.exceptions.DMSError
No zone security tags found for this domain.
Bases: dms.exceptions.ServerError
Server does not exist
JSONRPC Error: -75
Bases: dms.exceptions.ServerError
Server does not exist
JSONRPC Error: -76
Bases: dms.exceptions.DMSError
For a DMI, requested SG not found
JSONRPC Error: -59
Bases: dms.exceptions.UpdateError
No zone found in DNS server
JSONRPC Error: -6
This exception only occurs internally in dmsdmd, and dyndns_tool. It is not returned at all over HTTP JSON RPC.
Bases: dms.exceptions.DMSError
No zone security tags found for this domain.
JSONRPC Error: -44
Bases: dms.exceptions.DMSError
For a DMI, can’t find the requested zones.
JSONRPC Error: -32
Bases: dms.exceptions.ZoneParseError
7 fields were not supplied as required by RFC 1035
JSONRPC Error: -10
Bases: dms.exceptions.ZoneSearchPatternError
Only one lone ‘*’ or ‘%’ for zone search pattern is valid
JSONRPC Error: -98
Bases: dms.exceptions.RestoreNamedDbError
PID file format error
JSONRPC Error: -111
Bases: dms.exceptions.RestoreNamedDbError
PID file format error
JSONRPC Error: -110
Bases: dms.exceptions.ZoneParseError
Privilege is needed to set this RR field
JSONRPC Error: JSONRPC_INTERNAL_ERROR
Bases: dms.exceptions.ZoneParseError
RR has no type given.
JSONRPC Error: -97
Bases: dms.exceptions.ZoneParseError
Somewhere in the rdata processing (probably within dnspython) sense could not be made of the data
JSONRPC Error: -24
Bases: dms.exceptions.DMSError
Reference does not exist.
JSONRPC Error: -65
Bases: dms.exceptions.DMSError
Trying to create a reference that already exists.
JSONRPC Error: -64
Bases: dms.exceptions.DMSError
A reference can only consist of the characters ‘-_a-zA-Z0-9.@’, and must start with a letter or numeral. It also must be less than 1024 characters long.
JSONRPC Error: -82
Bases: dms.exceptions.ZoneSearchPatternError
When giving a zone search pattern, a reference must be given
JSONRPC Error: -99
Bases: dms.exceptions.DMSError
Reference is still in use
JSONRPC Error: -66
Bases: dms.exceptions.DMSError
A master SG already exists
JSONRPC Error: -114
Bases: dms.exceptions.DMSError
Subclass for Errors relating to restore_named_db DR functionality
Bases: dms.exceptions.InvalidDomainName
Reverse domain names are generated from CIDR network names.
JSONRPC Error: -91
Bases: dms.exceptions.DMSError
For query an RR, domain cannot start with ‘.’
JSONRPC Error: -81
Bases: dms.exceptions.ZoneParseError
Our zone parser does not support the RROP: RR flag in edit mode
JSONRPC Error: -85
Bases: dms.exceptions.SOASerialError
SOA Serial Arithmetic Error. Possibly due to memory corruption
JSONRPC Error: -3
Bases: dms.exceptions.SOASerialError
Proposed SOA Serial Candidate ignored.
JSONRPC Error: -118
Bases: dms.exceptions.DMSError
Ancestor for all SOA Serial arithmetic errors
Bases: dms.exceptions.ZoneParseError
SOA serial number must be an integer value.
JSONRPC Error: -11
Bases: dms.exceptions.SOASerialError
SOA Serial Occlusion Error. SOA serial as recorded in database is maximum of current SOA serial value in master DNS server.
Bases: dms.exceptions.SOASerialError
SOA Serial Published Error. SOA serial number update is the same as published value in database.
Bases: dms.exceptions.SOASerialError
SOA Serial Number is out of range must be > 0 and <= 2**32 -1.
JSONRPC Error: -120
Bases: dms.exceptions.SOASerialError
SOA Serial Number must be an integer.
Bases: dms.exceptions.DMSError
Operations on security tags can only be done with Admin privilege
JSONRPC Error: -46
Bases: dms.exceptions.ServerError
Server with the given address exists
JSONRPC Error: -77
Bases: dms.exceptions.DMSError
Ancestor class for server functions, saves code.
Bases: dms.exceptions.ServerError
Server already exists
JSONRPC Error: -74
Bases: dms.exceptions.ServerError
Server must be disabled for operation to proeceed.
JSONRPC Error: -78
Bases: dms.exceptions.DMSError
Server SM Failure - synchronous execution of the Server SM was not successful.
JSONRPC Error: -79
Bases: dms.exceptions.DMSError
For a DMI, SG already exists
JSONRPC Error: -72
Bases: dms.exceptions.DMSError
For a DMI, search for one requested SG found multiple entities
JSONRPC Error: -58
Bases: dms.exceptions.DMSError
SG Name is required for this configuration parameter
JSONRPC Error: -63
Bases: dms.exceptions.SgStillUsed
For a DMI, attempted deletion, SG still has servers
JSONRPC Error: -95
Bases: dms.exceptions.SgStillUsed
For a DMI, attempted deletion, SG still has zones
JSONRPC Error: -73
Bases: dms.exceptions.DMSError
Container class for SG Deleteion errors
Bases: dms.exceptions.ZoneSmFailure
Can’t tickle the edit lock timeout event due to an incorrect edit_lock_token
JSONRPC Error: -35
Bases: dms.exceptions.DirectiveParseError
$TTL not at top of zone file.
JSONRPC Error: -53
Bases: dms.exceptions.DirectiveParseError
Hostname parse error while parsing zone file.
JSONRPC Error: -52
Bases: dms.exceptions.ZiParseError
Zi related ttl value error.
JSONRPC Error: -49
Bases: dms.exceptions.ZoneParseError
Unhandled class for record - we only ever do IN
JSONRPC Error: -8
Bases: dms.exceptions.ZoneParseError
RR type is one we don’t handle.
JSONRPC Error: -9
Bases: dms.exceptions.DMSError
Error during update of zone
JSONRPC Error: -2
Bases: dms.exceptions.DMSError
An update of the given type is already queued for the zone
JSONRPC Error: -86
Bases: dms.exceptions.ZoneParseError
Our zone parser does not support the $UPDATE_TYPE statement in edit mode
JSONRPC Error: -84
Bases: dms.exceptions.DMSError
An update_type is required parameter for an incremental update.
JSONRPC Error: -87
Bases: dms.exceptions.ZoneSmFailure
Can’t update zone as it is locked.
JSONRPC Error: -35
Bases: dms.exceptions.ZiIdSyntaxError
ZI id adjustment sub string has invalid syntax.
JSONRPC Error: -101
Bases: dms.exceptions.ZiIdSyntaxError
ZI id sub string has an invalid DD/MM/YYYY date.
JSONRPC Error: -106
Bases: dms.exceptions.ZiIdSyntaxError
ZI id sub string has an invalid DD/MM date.
JSONRPC Error: -105
Bases: dms.exceptions.ZiIdSyntaxError
ZI id sub string has an invalid HH:MM time.
JSONRPC Error: -104
Bases: dms.exceptions.ZiIdSyntaxError
ZI id sub string has an invalid YYYY-MM-DD date.
JSONRPC Error: -107
Bases: dms.exceptions.DMSError
ZI id given has invalid syntax.
JSONRPC Error: -100
Bases: dms.exceptions.ZiIdSyntaxError
ZI id sub string has invalid time amount.
JSONRPC Error: -103
Bases: dms.exceptions.ZiIdSyntaxError
ZI id sub string has an invalid time unit specifier.
JSONRPC Error: -102
Bases: dms.exceptions.DMSError
Trying to delete a zi that is currently published.
JSONRPC Error: -38
Bases: dms.exceptions.ZoneNotFound
For a DMI, can’t find the requested zi.
JSONRPC Error: -30
Bases: dms.exceptions.DMSError
Zi related SOA/TTL data error.
JSONRPC Error: JSONRPC_INTERNAL_ERROR
Bases: dms.exceptions.DMSError
Parse Error. The zone file text input as zi_text must be of a valid format
JSONRPC Error: -126
Bases: dms.exceptions.DMSError
DMI has not been assigned the privilege required to edit this zone.
JSONRPC Error: -127
Bases: dms.exceptions.ZoneError
Zone already has an SOA record.
JSONRPC Error: -15
Bases: dms.exceptions.DMSError
A zone in the creation process can not be deleted or undeleted
JSONRPC Error: -62
Bases: dms.exceptions.ZoneError
Zone already has a CNAME using this label.
JSONRPC Error: -18
Bases: dms.exceptions.ZoneError
Zone already has a CNAME using this label.
JSONRPC Error: -19
Bases: dms.exceptions.ZoneCfgItem
An item with the given key name can not be found in the zone_cfg table
JSONRPC Error: -61
Bases: dms.exceptions.ZoneCfgItem
An item with the given key name can not be interpolated from its string
This can happen for string -> boolean conversions
JSONRPC Error: -71
Bases: dms.exceptions.ZoneError
Record in zone does not have valid in zone glue
JSONRPC Error: -21
Bases: dms.exceptions.DMSError
Zone disabled. Can’t do operation.
JSONRPC Error: -88
Bases: dms.exceptions.ZoneParseError
Zone related resource record error.
JSONRPC Error: JSONRPC_INTERNAL_ERROR
Bases: dms.exceptions.DMSError
Trying to create a zone that already exists
JSONRPC Error: -36
Bases: dms.exceptions.RestoreNamedDbError
Can’t write zone file
JSONRPC Error: -112
Bases: dms.exceptions.ZoneSmFailure
Can’t destroy/nuke a zone as its zone files still exist
JSONRPC Error: -70
Bases: dms.exceptions.ZoneError
Zone has No NS records.
JSONRPC Error: -23
Bases: dms.exceptions.DMSError
Zone has No SOA record.
JSONRPC Error: -22
Bases: dms.exceptions.DMSError
For a Zone, no ZI has no candidate or published ZI
JSONRPC Error: - 92
Bases: dms.exceptions.DMSError
For a DMI, search for one requested zone found multiple entities
JSONRPC Error: -57
Bases: dms.exceptions.DMSError
Name of the Zone can not be determined.
JSONRPC Error: -47
Bases: dms.exceptions.DMSError
Zone idoes not have an alternate SG for swapping
JSONRPC Error: -123
Bases: dms.exceptions.DMSError
Trying to destroy a zone that is active
JSONRPC Error: -37
Bases: dms.exceptions.DMSError
Zone disabled. Can’t do operation.
JSONRPC Error: -94
Bases: dms.exceptions.DMSError
Zone is not DNSSEC enabled.
JSONRPC Error: -60
Bases: dms.exceptions.DMSError
For a DMI, can’t find the requested zone.
JSONRPC Error: -28
Bases: dms.exceptions.ZoneNotFound
For a DMI, can’t find the requested zone.
JSONRPC Error: -29
Bases: dms.exceptions.DMSError
Zone Not Published. Can’t poke DNS server.
JSONRPC Error: -117
Bases: dms.exceptions.DMSError
Parent class for zi RR errors
JSONRPC Error: JSONRPC_INTERNAL_ERROR
Bases: dms.exceptions.ZoneError
Zone already has an SOA record.
JSONRPC Error: -16
Bases: dms.exceptions.DMSError
Given zone search pattern is invalid
Bases: dms.exceptions.ZoneSecTagDoesNotExist
Zone security tag for DMS server does not exist.
JSONRPC Error: -42
Bases: dms.exceptions.DMSError
Zone security tag does not exist.
JSONRPC Error: -41
Bases: dms.exceptions.DMSError
Trying to create a security tag that already exists.
JSONRPC Error: -40
Bases: dms.exceptions.DMSError
Zone security tag is still in use
JSONRPC Error: -43
Bases: dms.exceptions.DMSError
Zone SM Failure - synchronous execution of the Zone SM was not successful.
JSONRPC Error: -80
Bases: dms.exceptions.DMSError
The zone ttl needs to be set in the RR database row
JSONRPC Error: -1