4.1.4.4.2.1. DSFRecords

class dyn.tm.services.dsf.DSFARecord(address, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An ARecord object which is able to store additional data for use by a TrafficDirector service.

__init__(address, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFARecord object

Parameters:

• address – IPv4 address for the record
• ttl – TTL for this record
• label – A unique label for this DSFARecord
• weight – Weight for this DSFARecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFAAAARecord(address, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An AAAARecord object which is able to store additional data for use by a TrafficDirector service.

__init__(address, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFAAAARecord object

Parameters:

• address – IPv6 address for the record
• ttl – TTL for this record
• label – A unique label for this DSFAAAARecord
• weight – Weight for this DSFAAAARecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFCERTRecord(format, tag, algorithm, certificate, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An CERTRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(format, tag, algorithm, certificate, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFCERTRecord object

Parameters:

• format – Numeric value for the certificate type
• tag – Numeric value for the public key certificate
• algorithm – Public key algorithm number used to generate the certificate
• certificate – The public key certificate
• ttl – TTL for this record
• label – A unique label for this DSFCERTRecord
• weight – Weight for this DSFCERTRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFCNAMERecord(cname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An CNAMERecord object which is able to store additional data for use by a TrafficDirector service.

__init__(cname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFCNAMERecord object

Parameters:

• cname – Hostname
• ttl – TTL for this record
• label – A unique label for this DSFCNAMERecord
• weight – Weight for this DSFCNAMERecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFDHCIDRecord(digest, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An DHCIDRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(digest, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFDHCIDRecord object

Parameters:

• digest – Base-64 encoded digest of DHCP data
• ttl – TTL for this record
• label – A unique label for this DSFDHCIDRecord
• weight – Weight for this DSFDHCIDRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFDNAMERecord(dname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An DNAMERecord object which is able to store additional data for use by a TrafficDirector service.

__init__(dname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFDNAMERecord object

Parameters:

• dname – Target Hostname
• ttl – TTL for this record
• label – A unique label for this DSFDNAMERecord
• weight – Weight for this DSFDNAMERecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFDNSKEYRecord(protocol, public_key, algorithm=5, flags=256, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An DNSKEYRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(protocol, public_key, algorithm=5, flags=256, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFDNSKEYRecord object

Parameters:

• protocol – Numeric value for protocol
• public_key – The public key for the DNSSEC signed zone
• algorithm – Numeric value representing the public key encryption algorithm which will sign the zone. Must be one of 1 (RSA-MD5), 2 (Diffie-Hellman), 3 (DSA/SHA-1), 4 (Elliptic Curve), or 5 (RSA-SHA-1)
• flags – Numeric value confirming this is the zone’s DNSKEY
• ttl – TTL for this record
• label – A unique label for this DSFDNSKEYRecord
• weight – Weight for this DSFDNSKEYRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFDSRecord(digest, keytag, algorithm=5, digtype=1, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An DSRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(digest, keytag, algorithm=5, digtype=1, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFDSRecord object

Parameters:

• digest – The digest in hexadecimal form. 20-byte, hexadecimal-encoded, one-way hash of the DNSKEY record surrounded by parenthesis characters ‘(‘ & ‘)’
• keytag – The digest mechanism to use to verify the digest
• algorithm – Numeric value representing the public key encryption algorithm which will sign the zone. Must be one of 1 (RSA-MD5), 2 (Diffie-Hellman), 3 (DSA/SHA-1), 4 (Elliptic Curve), or 5 (RSA-SHA-1)
• digtype – the digest mechanism to use to verify the digest. Valid values are SHA1, SHA256
• ttl – TTL for this record
• label – A unique label for this DSFDSRecord
• weight – Weight for this DSFDSRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFKEYRecord(algorithm, flags, protocol, public_key, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An KEYRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(algorithm, flags, protocol, public_key, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFKEYRecord object

Parameters:

• algorithm – Numeric value representing the public key encryption algorithm which will sign the zone. Must be one of 1 (RSA-MD5), 2 (Diffie-Hellman), 3 (DSA/SHA-1), 4 (Elliptic Curve), or 5 (RSA-SHA-1)
• flags – See RFC 2535 for information on KEY record flags
• protocol – Numeric identifier of the protocol for this KEY record
• public_key – The public key for this record
• ttl – TTL for this record
• label – A unique label for this DSFKEYRecord
• weight – Weight for this DSFKEYRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFKXRecord(exchange, preference, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An KXRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(exchange, preference, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFKXRecord object

Parameters:

• exchange – Hostname that will act as the Key Exchanger. The hostname must have a CNAMERecord, an ARecord and/or an AAAARecord associated with it
• preference – Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node
• ttl – TTL for this record
• label – A unique label for this DSFKXRecord
• weight – Weight for this DSFKXRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFLOCRecord(altitude, latitude, longitude, horiz_pre=10000, size=1, vert_pre=10, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An LOCRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(altitude, latitude, longitude, horiz_pre=10000, size=1, vert_pre=10, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFLOCRecord object

Parameters:

• altitude – Measured in meters above sea level
• horiz_pre –
• latitude – Measured in degrees, minutes, and seconds with N/S indicator for North and South
• longitude – Measured in degrees, minutes, and seconds with E/W indicator for East and West
• size –
• version –
• vert_pre –
• ttl – TTL for this record
• label – A unique label for this DSFLOCRecord
• weight – Weight for this DSFLOCRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFIPSECKEYRecord(precedence, gatetype, algorithm, gateway, public_key, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An IPSECKEYRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(precedence, gatetype, algorithm, gateway, public_key, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFIPSECKEYRecord object

Parameters:

• precedence – Indicates priority among multiple IPSECKEYS. Lower numbers are higher priority
• gatetype – Gateway type. Must be one of 0, 1, 2, or 3
• algorithm – Public key’s cryptographic algorithm and format. Must be one of 0, 1, or 2
• gateway – Gateway used to create IPsec tunnel. Based on Gateway type
• public_key – Base64 encoding of the public key. Whitespace is allowed
• ttl – TTL for this record
• label – A unique label for this DSFIPSECKEYRecord
• weight – Weight for this DSFIPSECKEYRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFMXRecord(exchange, preference=10, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An MXRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(exchange, preference=10, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFMXRecord object

Parameters:

• exchange – Hostname of the server responsible for accepting mail messages in the zone
• preference – Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node.
• ttl – TTL for this record
• label – A unique label for this DSFMXRecord
• weight – Weight for this DSFMXRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFNAPTRRecord(order, preference, services, regexp, replacement, flags='U', ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An NAPTRRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(order, preference, services, regexp, replacement, flags='U', ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFNAPTRRecord object

Parameters:

• order – Indicates the required priority for processing NAPTR records. Lowest value is used first.
• preference – Indicates priority where two or more NAPTR records have identical order values. Lowest value is used first.
• services – Always starts with “e2u+” (E.164 to URI). After the e2u+ there is a string that defines the type and optionally the subtype of the URI where this NAPTRRecord points.
• regexp – The NAPTR record accepts regular expressions
• replacement – The next domain name to find. Only applies if this NAPTRRecord is non-terminal.
• flags – Should be the letter “U”. This indicates that this NAPTR record terminal
• ttl – TTL for this record
• label – A unique label for this DSFNAPTRRecord
• weight – Weight for this DSFNAPTRRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFPTRRecord(ptrdname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An PTRRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(ptrdname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFPTRRecord object

Parameters:

• ptrdname – The hostname where the IP address should be directed
• ttl – TTL for this record
• label – A unique label for this DSFPTRRecord
• weight – Weight for this DSFPTRRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFPXRecord(preference, map822, mapx400, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An PXRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(preference, map822, mapx400, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFPXRecord object

Parameters:

• preference – Sets priority for processing records of the same type. Lowest value is processed first.
• map822 – mail hostname
• mapx400 – The domain name derived from the X.400 part of MCGAM
• ttl – TTL for this record
• label – A unique label for this DSFPXRecord
• weight – Weight for this DSFPXRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFNSAPRecord(nsap, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An NSAPRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(nsap, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFNSAPRecord object

Parameters:

• nsap – Hex-encoded NSAP identifier
• ttl – TTL for this record
• label – A unique label for this DSFNSAPRecord
• weight – Weight for this DSFNSAPRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFRPRecord(mbox, txtdname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An RPRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(mbox, txtdname, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFRPRecord object

Parameters:

• mbox – Email address of the Responsible Person.
• txtdname – Hostname where a TXT record exists with more information on the responsible person.
• ttl – TTL for this record
• label – A unique label for this DSFRPRecord
• weight – Weight for this DSFRPRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFNSRecord(nsdname, service_class='', ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An NSRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(nsdname, service_class='', ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFNSRecord object

Parameters:

• nsdname – Hostname of the authoritative Nameserver for the zone
• service_class – Hostname of the authoritative Nameserver for the zone
• ttl – TTL for this record
• label – A unique label for this DSFNSRecord
• weight – Weight for this DSFNSRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFSPFRecord(txtdata, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An SPFRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(txtdata, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFSPFRecord object

Parameters:

• txtdata – Free text containing SPF record information
• ttl – TTL for this record
• label – A unique label for this DSFSPFRecord
• weight – Weight for this DSFSPFRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFSRVRecord(port, priority, target, rr_weight, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An SRVRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(port, priority, target, rr_weight, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFSRVRecord object

Parameters:

• port – Indicates the port where the service is running
• priority – Numeric value for priority usage. Lower value takes precedence over higher value where two records of the same type exist on the zone/node
• target – The domain name of a host where the service is running on the specified port
• rr_weight – Secondary prioritizing of records to serve. Records of equal priority should be served based on their weight. Higher values are served more often
• ttl – TTL for this record
• label – A unique label for this DSFSRVRecord
• weight – Weight for this DSFSRVRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

class dyn.tm.services.dsf.DSFTXTRecord(txtdata, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

An TXTRecord object which is able to store additional data for use by a TrafficDirector service.

__init__(txtdata, ttl=0, label=None, weight=1, automation='auto', endpoints=None, endpoint_up_count=None, eligible=True, **kwargs)

Create a DSFTXTRecord object

Parameters:

• txtdata – Plain text data to be served by this DSFTXTRecord
• ttl – TTL for this record
• label – A unique label for this DSFTXTRecord
• weight – Weight for this DSFTXTRecord
• automation – Defines how eligible can be changed in response to monitoring. Must be one of ‘auto’, ‘auto_down’, or ‘manual’
• endpoints – Endpoints are used to determine status, torpidity, and eligible in response to monitor data
• endpoint_up_count – Number of endpoints that must be up for the Record status to be ‘up’
• eligible – Indicates whether or not the Record can be served

4.1.4.4.2.2. DSFRecordSet

class dyn.tm.services.dsf.DSFRecordSet(rdata_class, label=None, ttl=None, automation=None, serve_count=None, fail_count=None, trouble_count=None, eligible=None, dsf_monitor_id=None, records=None, **kwargs)

A Collection of DSFRecord Type objects belonging to a DSFFailoverChain

__init__(rdata_class, label=None, ttl=None, automation=None, serve_count=None, fail_count=None, trouble_count=None, eligible=None, dsf_monitor_id=None, records=None, **kwargs)

Create a new DSFRecordSet object

Parameters:

• rdata_class – The type of rdata represented by this DSFRecordSet
• label – A unique label for this DSFRecordSet
• ttl – Default TTL for DSFRecord‘s within this DSFRecordSet
• automation – Defines how eligible can be changed in response to monitoring
• serve_count – How many Records to serve out of this DSFRecordSet
• fail_count – The number of Records that must not be okay before this DSFRecordSet becomes ineligible.
• trouble_count – The number of Records that must not be okay before this DSFRecordSet becomes in trouble.
• eligible – Indicates whether or not this DSFRecordSet can be served.
• dsf_monitor_id – The unique system id of the DSF Monitor attached to this DSFRecordSet
• records – A list of DSFRecord‘s within this DSFRecordSet
• kwargs – Used for manipulating additional data to be speicified by the creation of other system objects.

automation

Defines how eligible can be changed in response to monitoring

delete()

Delete this DSFRecordSet from the Dynect System

dsf_monitor_id

The unique system id of the DSF Monitor attached to this DSFRecordSet

eligible

Indicates whether or not this DSFRecordSet can be served.

fail_count

The number of Records that must not be okay before this DSFRecordSet becomes ineligible.

label

A unique label for this DSFRecordSet

rdata_class

The rdata property is a read-only attribute

records

The list of DSFRecord types that are stored in this DSFRecordSet

serve_count

How many Records to serve out of this DSFRecordSet

status

The current status of this DSFRecordSet

to_json()

Convert this DSFRecordSet to a JSON blob

trouble_count

The number of Records that must not be okay before this DSFRecordSet becomes in trouble.

ttl

Default TTL for DSFRecord‘s within this DSFRecordSet

4.1.4.4.2.3. DSFFailoverChain

class dyn.tm.services.dsf.DSFFailoverChain(label=None, core=None, record_sets=None, **kwargs)

docstring for DSFFailoverChain

__init__(label=None, core=None, record_sets=None, **kwargs)

Create a DSFFailoverChain object

Parameters:

• label – A unique label for this DSFFailoverChain
• core – Indicates whether or not the contained DSFRecordSets are core record sets
• record_sets – A list of DSFRecordSet‘s for this DSFFailoverChain

core

Indicates whether or not the contained DSFRecordSet‘s are core record sets.

delete()

Delete this DSFFailoverChain from the Dynect System

label

A unique label for this DSFFailoverChain

record_sets

A list of hashes to create a new DSFRecordSet or specify/update an existing DSFRecordSet

to_json()

Convert this DSFFailoverChain to a JSON blob

4.1.4.4.2.4. DSFResponsePool

class dyn.tm.services.dsf.DSFResponsePool(label, core_set_count=1, eligible=True, automation='auto', dsf_ruleset_id=None, index=None, rs_chains=None, **kwargs)

docstring for DSFResponsePool

__init__(label, core_set_count=1, eligible=True, automation='auto', dsf_ruleset_id=None, index=None, rs_chains=None, **kwargs)

Create a DSFResponsePool object

Parameters:

• label – A unique label for this DSFResponsePool
• core_set_count – If fewer than this number of core record sets are eligible, status will be set to fail
• eligible – Indicates whether or not the DSFResponsePool can be served
• automation – Defines how eligible can be changed in response to monitoring
• dsf_ruleset_id – Unique system id of the Ruleset this DSFResponsePool is attached to
• index – When specified with dsf_ruleset_id, indicates the position of the DSFResponsePool
• rs_chains – A list of DSFFailoverChain that are defined for this DSFResponsePool

automation

Defines how eligible can be changed in response to monitoring

core_set_count

If fewer than this number of core record sets are eligible, status will be set to fail

delete()

Delete this DSFResponsePool from the DynECT System

dsf_ruleset_id

Unique system id of the Ruleset this DSFResponsePool is attached to

eligible

Indicates whether or not the DSFResponsePool can be served

label

A unique label for this DSFResponsePool

rs_chains

A list of DSFFailoverChain that are defined for this DSFResponsePool

to_json()

Convert this DSFResponsePool to a JSON blob

4.1.4.4.2.5. DSFRuleset

class dyn.tm.services.dsf.DSFRuleset(label, criteria_type, response_pools, criteria=None, **kwargs)

docstring for DSFRuleset

__init__(label, criteria_type, response_pools, criteria=None, **kwargs)

Create a DSFRuleset object

Parameters:

• label – A unique label for this DSFRuleset
• criteria_type – A set of rules describing what traffic is applied to the DSFRuleset
• criteria – Varied depending on the specified criteria_type
• response_pools – A list of DSFResponsePool‘s for this DSFRuleset

criteria

The criteria rules, will be varied depending on the specified criteria_type

criteria_type

A set of rules describing what traffic is applied to the DSFRuleset

delete()

Remove this DSFRuleset from it’s associated TrafficDirector Service

label

A unique label for this DSFRuleset

response_pools

A list of DSFResponsePool‘s for this DSFRuleset

4.1.4.4.2.6. DSFMonitor

class dyn.tm.services.dsf.DSFMonitor(*args, **kwargs)

A Monitor for a TrafficDirector Service

__init__(*args, **kwargs)

Create a new DSFMonitor object

Parameters:

• label – A unique label to identify this DSFMonitor
• protocol – The protocol to monitor. Must be one of ‘HTTP’, ‘HTTPS’, ‘PING’, ‘SMTP’, or ‘TCP’
• response_count – The number of responses to determine whether or not the endpoint is ‘up’ or ‘down’
• probe_interval – How often to run this DSFMonitor
• retries – How many retries this DSFMonitor should attempt on failure before giving up.
• active – Indicates if this DSFMonitor is active
• options – Additional options pertaining to this DSFMonitor
• endpoints – A List of DSFMonitorEndpoint‘s that are associated with this DSFMonitor

active

Returns whether or not this DSFMonitor is active. Will return either ‘Y’ or ‘N’

delete()

Delete an existing DSFMonitor from the DynECT System

dsf_monitor_id

The unique system id of this DSFMonitor

endpoints

A list of the endpoints (and their statuses) that this DSFMonitor is currently monitoring.

label

A unique label to identify this DSFMonitor

options

Additional options pertaining to this DSFMonitor

probe_interval

How often to run this DSFMonitor

protocol

The protocol to monitor. Must be one of ‘HTTP’, ‘HTTPS’, ‘PING’, ‘SMTP’, or ‘TCP’

response_count

The number of responses to determine whether or not the endpoint is ‘up’ or ‘down’

retries

How many retries this DSFMonitor should attempt on failure before giving up.

4.1.4.4.2.7. Traffic Director

class dyn.tm.services.dsf.TrafficDirector(*args, **kwargs)

Traffic Director is a DNS based traffic routing and load balancing service that is Geolocation aware and can support failover by monitoring endpoints.

__init__(*args, **kwargs)

Create a TrafficDirector object

Parameters:

• label – A unique label for this TrafficDirector service
• ttl – The default TTL to be used across this service
• publish – If Y, service will be published on creation
• nodes – A list of zone, FQDN pairs in a hash that are to be linked to this TrafficDirector service:
• notifiers – A list of names of notifiers associated with this TrafficDirector service
• rulesets – A list of DSFRulesets that are defined for this TrafficDirector service

add_notifier(notifier_id, publish='Y')

Links the Notifier with the specified id to this Traffic Director service

delete()

Delete this TrafficDirector from the DynECT System

label

A unique label for this TrafficDirector service

nodes

A list of zone, FQDN pairs in a hash that are linked, or to be linked to this TrafficDirector service

notifiers

A list of names of notifiers associated with this TrafficDirector service

record_sets

A list of this TrafficDirector Services DSFRecordSet‘s

records

A list of this TrafficDirector Services’ DSFRecords

remove_orphans()

Remove Record Set Chains which are no longer referenced by a DSFResponsePool

response_pools

A list of this TrafficDirector Services DSFResponsePool‘s

revert_changes()

Clears the changeset for this service and reverts all non-published changes to their original state

rs_chains

A list of this TrafficDirector Services DSFFailoverChain‘s

rulesets

A list of DSFRulesets that are defined for this TrafficDirector service

service_id

The unique System id of this DSF Service

ttl

The default TTL to be used across this service

4.1.4.4.2.7.1. Traffic Director Examples

The following examples highlight how to use the TrafficDirector class to get/create TrafficDirector‘s on the dyn.tm System and how to edit these objects from within a Python script.

4.1.4.4.2.7.1.1. Creating a new Traffic Director Service

The following example shows how to create a new TrafficDirector on the dyn.tm System and how to edit some of the fields using the returned TrafficDirector object.

>>> from dyn.tm.records import ARecord
>>> from dyn.tm.services.dsf import DSFRecord, DSFRecordSet, \
...     DSFFailoverChain, DSFResponsePool, DSFRuleset, DSFMonitor, TrafficDirector
>>> # Create a dyn.tmSession
>>> # Assuming you own the zone 'example.com'
>>> zone = 'example.com'
>>> fqdn = zone + '.'
>>> a_rec = DSFARecord('1.1.1.1', ttl=60, label='RecordLabel')
>>> record_set = DSFRecordSet('A', label='RSLabel', records=[record])
>>> failover_chain = DSFFailoverChain(label='FCLabel', record_sets=[record_set])
>>> rp = DSFResponsePool(label='RPLabel', rs_chains=[failover_chain])
>>> criteria = {'geoip': {'country': ['US']}}
>>> ruleset = DSFRuleset(label='RSLabel', criteria_type='geoip',
...                      criteria=criteria, response_pools=[rp])
>>> monitor = DSFMonitor('MonLabel', 'HTTP', 1, 60, 1, port=8080)
>>> dsf = TrafficDirector('DSFLabel', rulesets=[ruleset])

4.1.4.4.2.7.1.2. Getting an Existing Traffic Director Service

The following example shows how to get an existing TrafficDirector from the dyn.tm System and how to edit some of the same fields mentioned above.

>>> # Continuing from the previous example
>>> dsf_id = dsf.service_id
>>> dsf = TrafficDirector(dsf_id)