Class DNS

class proteus.api.dns.DNS(proteus_client=None)

Bases: object

Proteus DNS Management Class

Parameters:

• proteus_client : instance of proteus.api.client.ProteusClient

_find_zone(zonename, view=None, view_name=None)

Find last zone from zonename

Parameters:

• zonename (str) – Zonename i.e. ‘subdomain.domain.tld’
• view (proteus.objects.apientity.View) – View Object (can be None when view_name is not None)
• view_name (str) – View Name (can be None, when view is not None)

Returns:

proteus.objects.apientity.Zone

See: [1]

_get_record(hostname, zonename, view=None, view_name=None, rec_type='HostRecord')

Generic method to retrieve the Proteus Resource Records

Parameters:

• hostname : string
• zonename : string
• view : proteus.objects.apientity.View
• view_name : string
• rec_type : string [ should be one of proteus.api.constants.DNS_ALLTYPES ]

Returns:

• Depends on the result of Proteus call but can be one of these:

  • proteus.objects.apientity.HostRecord
  • proteus.objects.apientity.MXRecord
  • proteus.objects.apientity.TXTRecord
  • proteus.objects.apientity.HINFORecord
  • proteus.objects.apientity.CNAMERecord
  • proteus.objects.apientity.SRVRecord

See: [1]

_get_records_by_zone(zone=None, record_type='Zone')

Retrieve a list of Resource Records from Proteus

Parameters:

• zone (proteus.objects.apientity.Zone) – Zone
• record_type (str (use constants from proteus.api.constants) – Record type to retreive

Returns:

• Depending on the input type it can return:

  • proteus.objects.apientity.HostRecord
  • proteus.objects.apientity.MXRecord
  • proteus.objects.apientity.TXTRecord
  • proteus.objects.apientity.SRVRecord
  • proteus.objects.apientity.HINFORecord

get_cname_record(hostname, zonename, view=None, view_name=None)

Retrieve CNAME Record from Proteus

Parameters:

• hostname (str) – the hostname
• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View name (can be None when view_name is not None)
• view_name (str) – View Name (can be None when view is not None)

Returns:

proteus.objects.apientity.CNAMERecord

get_hinfo_record(hostname, zonename, view=None, view_name=None)

Retrieve HINFO Record from Proteus

Parameters:

• hostname (str) – the hostname
• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View name (can be None when view_name is not None)
• view_name (str) – View Name (can be None when view is not None)

Returns:

proteus.objects.apientity.HINFORecord

get_host_record(hostname, zonename, view=None, view_name=None)

Retrieve Host Record from Proteus

Parameters:

• hostname (str) – the hostname
• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View name (can be None when view_name is not None)
• view_name (str) – View Name (can be None when view is not None)

Returns:

proteus.objects.apientity.HostRecord

get_mx_record(hostname, zonename, view=None, view_name=None)

Retrieve Mailexchanger Record from Proteus

Parameters:

• hostname (str) – the hostname
• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View name (can be None when view_name is not None)
• view_name (str) – View Name (can be None when view is not None)

Returns:

proteus.objects.apientity.MXRecord

get_srv_record(hostname, zonename, view=None, view_name=None)

Retrieve SRV Record from Proteus

Parameters:

• hostname (str) – the hostname
• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View name (can be None when view_name is not None)
• view_name (str) – View Name (can be None when view is not None)

Returns:

proteus.objects.apientity.SRVRecord

get_txt_record(hostname, zonename, view=None, view_name=None)

Retrieve TXT Record from Proteus

Parameters:

• hostname (str) – the hostname
• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View name (can be None when view_name is not None)
• view_name (str) – View Name (can be None when view is not None)

Returns:

proteus.objects.apientity.TXTRecord

get_view(view_name)

Get the Proteus View

Parameters:

• view_name : string

Returns:

• proteus.objects.apientity.View

get_views()

Get a list of all Views in Proteus

Returns:

• list of proteus.objects.apientity.View

get_zone(zone_name=None, view=None, view_name=None)

Get a Zone Record from Proteus

Parameters:

• zone_name : string
• view : proteus.objects.apientity.View
• view_name : string

Returns:

• proteus.objects.apientity.Zone

get_zone_list(zonename, view=None, view_name=None, rec_type=['Zone', 'HostRecord', 'MXRecord', 'TXTRecord', 'AliasRecord', 'HINFORecord', 'SRVRecord'])

Retrieves a list of resource records for a special zone from Proteus

Parameters:

• zonename (str) – Name of the Zone i.e. ‘subzone.domain.tld’
• view (proteus.objects.apientity.View) – View (can be None when view_name is not None)
• view_name (str) – Name of the View (can be None when view is not None)
• rec_type (str (use one of the constants of proteus.api.constants or use DNS_ALLTYPES)) – Type of Record to return

Returns:

• Depending on the input type it can return:

  • proteus.objects.apientity.HostRecord
  • proteus.objects.apientity.MXRecord
  • proteus.objects.apientity.TXTRecord
  • proteus.objects.apientity.SRVRecord
  • proteus.objects.apientity.HINFORecord

• or when rec_type is DNS_ALLTYPES:

  • return a mixed list of all types above

Footnotes

[1]	(1, 2) Private Method, only for use inside the class