l.d.b.DNSDriver(BaseDriver) : class documentation

Part of libcloud.dns.base View Source View In Hierarchy

Known subclasses: libcloud.dns.drivers.dummy.DummyDNSDriver, libcloud.dns.drivers.linode.LinodeDNSDriver, libcloud.dns.drivers.rackspace.RackspaceDNSDriver, libcloud.dns.drivers.zerigo.ZerigoDNSDriver

DNS driver.
Method __init__
Method list_record_types Return a list of RecordType objects supported by the provider.
Method list_zones Return a list of zones.
Method list_records Return a list of records for the provided zone.
Method get_zone Return a Zone instance.
Method get_record Return a Record instance.
Method create_zone Create a new zone.
Method update_zone Update en existing zone.
Method create_record Create a new record.
Method update_record Update an existing record.
Method delete_zone Delete a zone.
Method delete_record Delete a record.
Method _string_to_record_type Return a string representation of a DNS record type to a libcloud RecordType ENUM.

Inherited from BaseDriver:

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def __init__(self, key, secret=None, secure=True, host=None, port=None, **kwargs): (source)
ParameterskeyAPI key or username to used (type: str)
secretSecret password to be used (type: str)
secureWeither to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default. (type: bool)
hostOverride hostname used for connections. (type: str)
portOverride port used for connections. (type: int)
api_versionOptional API version. Only used by drivers which support multiple API versions. (type: str)
def list_record_types(self): (source)
Return a list of RecordType objects supported by the provider.
ReturnsA list of RecordType instances.
def list_zones(self): (source)
Return a list of zones.
ReturnsA list of Zone instances.
def list_records(self, zone): (source)
Return a list of records for the provided zone.
ParameterszoneZone to list records for. (type: Zone)
ReturnsA list of Record instances.
def get_zone(self, zone_id): (source)
Return a Zone instance.
ReturnsZone instance.
def get_record(self, zone_id, record_id): (source)
Return a Record instance.
ReturnsRecord instance.
def create_zone(self, domain, type='master', ttl=None, extra=None): (source)
Create a new zone.
ParametersdomainZone domain name. (type: string)
typeZone type (master / slave). (type: string)
ttlint
ttl(optional) TTL for new records.
extra(optional) Extra attributes (driver specific). (type: dict)
def update_zone(self, zone, domain, type='master', ttl=None, extra=None): (source)
Update en existing zone.
ParameterszoneZone to update. (type: Zone)
domainZone domain name. (type: string)
typeZone type (master / slave). (type: string)
ttlint
ttl(optional) TTL for new records.
extra(optional) Extra attributes (driver specific). (type: dict)
def create_record(self, name, zone, type, data, extra=None): (source)
Create a new record.
Parametersnamestring (type: Hostname or FQDN.)
zoneZone where the requested record is created. (type: Zone)
typeDNS record type (A, AAAA, ...). (type: RecordType)
dataData for the record (depends on the record type). (type: str)
extra(optional) Extra attributes (driver specific). (type: dict)
def update_record(self, record, name, type, data, extra): (source)
Update an existing record.
ParametersrecordRecord (type: Record to update.)
namestring (type: Hostname or FQDN.)
typeDNS record type (A, AAAA, ...). (type: RecordType)
dataData for the record (depends on the record type). (type: str)
extra(optional) Extra attributes (driver specific). (type: dict)
def delete_zone(self, zone): (source)
Delete a zone.

Note: This will delete all the records belonging to this zone.

ParameterszoneZone (type: Zone to delete.)
def delete_record(self, record): (source)
Delete a record.
ParametersrecordRecord (type: Record to delete.)
def _string_to_record_type(self, string): (source)
Return a string representation of a DNS record type to a libcloud RecordType ENUM.
API Documentation for libcloud, generated by pydoctor at 2012-07-15 18:49:10.