Storage

Storage Base

class designate.storage.base.Storage

Bases: designate.plugin.DriverPlugin

Base class for storage plugins

abstract count_records(context, criterion=None)

Count records

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract count_recordsets(context, criterion=None)

Count recordsets

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract count_tenants(context)

Count tenants

Parameters

context – RPC Context.

abstract count_zones(context, criterion=None)

Count zones

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract create_blacklist(context, blacklist)

Create a Blacklist.

Parameters

• context – RPC Context.

• blacklist – Blacklist object with the values to be created.

abstract create_pool(context, pool)

Create a Pool.

Parameters

• context – RPC Context.

• pool – Pool object with the values to be created.

abstract create_pool_attribute(context, pool_id, pool_attribute)

Create a PoolAttribute.

Parameters

• context – RPC Context.

• pool_id – The ID of the pool to which the attribute belongs.

• pool_attribute – PoolAttribute object with the values created.

abstract create_quota(context, quota)

Create a Quota.

Parameters

• context – RPC Context.

• quota – Quota object with the values to be created.

abstract create_record(context, zone_id, recordset_id, record)

Create a record on a given Zone ID

Parameters

• context – RPC Context.

• zone_id – Zone ID to create the record in.

• recordset_id – RecordSet ID to create the record in.

• record – Record object with the values to be created.

abstract create_recordset(context, zone_id, recordset)

Create a recordset on a given Zone ID

Parameters

• context – RPC Context.

• zone_id – Zone ID to create the recordset in.

• recordset – RecordSet object with the values to be created.

abstract create_tld(context, tld)

Create a TLD.

Parameters

• context – RPC Context.

• tld – Tld object with the values to be created.

abstract create_tsigkey(context, tsigkey)

Create a TSIG Key.

Parameters

• context – RPC Context.

• tsigkey – TsigKey object with the values to be created.

abstract create_zone(context, zone)

Create a new Zone.

Parameters

• context – RPC Context.

• zone – Zone object with the values to be created.

abstract create_zone_export(context, zone_export)

Create a Zone Export.

Parameters

• context – RPC Context.

• zone_export – Zone Export object with the values to be created.

abstract create_zone_import(context, zone_import)

Create a Zone Import.

Parameters

• context – RPC Context.

• zone_import – Zone Import object with the values to be created.

abstract delete_blacklist(context, blacklist_id)

Delete a Blacklist via ID.

Parameters

• context – RPC Context.

• blacklist_id – Delete a Blacklist via ID

abstract delete_pool(context, pool_id)

Delete the pool with the matching id

Parameters

• context – RPC Context.

• pool_id – The ID of the pool to be deleted

abstract delete_pool_attribute(context, pool_attribute_id)

Delete the pool with the matching id

Parameters

• context – RPC Context.

• pool_attribute_id – The ID of the PoolAttribute to be deleted

abstract delete_quota(context, quota_id)

Delete a Quota via ID.

Parameters

• context – RPC Context.

• quota_id – Delete a Quota via ID

abstract delete_record(context, record_id)

Delete a record

Parameters

• context – RPC Context.

• record_id – Record ID to delete

abstract delete_recordset(context, recordset_id)

Delete a recordset

Parameters

• context – RPC Context.

• recordset_id – RecordSet ID to delete

abstract delete_tld(context, tld_id)

Delete a TLD via ID.

Parameters

• context – RPC Context.

• tld_id – Delete a TLD via ID

abstract delete_tsigkey(context, tsigkey_id)

Delete a TSIG Key via ID.

Parameters

• context – RPC Context.

• tsigkey_id – Delete a TSIG Key via ID

abstract delete_zone(context, zone_id)

Delete a Zone

Parameters

• context – RPC Context.

• zone_id – Zone ID to delete.

abstract delete_zone_export(context, zone_export_id)

Delete a Zone Export via ID.

Parameters

• context – RPC Context.

• zone_export_id – Delete a Zone Export via ID

abstract delete_zone_import(context, zone_import_id)

Delete a Zone Import via ID.

Parameters

• context – RPC Context.

• zone_import_id – Delete a Zone Import via ID

abstract find_blacklist(context, criterion)

Find a single Blacklist.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_blacklists(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find Blacklists

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_pool(context, criterion)

Find a single Pool.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_pool_attribute(context, criterion)

Find a single PoolAttribute

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_pool_attributes(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find all PoolAttributes

Parameters

• context – RPC Context

• criterion – Criteria by which to filer

• marker – Resource ID used by paging. The next page will start at the next resource after the marker

• limit – Integer limit of objects on the page

• sort_key – Key used to sort the returned list

• sort_dir – Directions to sort after using sort_key

abstract find_pools(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find all Pools

Parameters

• context – RPC Context.

• criterion – Criteria by which to filter

• marker – Resource ID used by paging. The next page will start at the next resource after the marker

• limit – Integer limit of objects on the page

• sort_key – Key used to sort the returned list

• sort_dir – Directions to sort after using sort_key

abstract find_quota(context, criterion)

Find a single Quota.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_quotas(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find Quotas

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_record(context, criterion)

Find a single Record.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_records(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find Records.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_recordset(context, criterion)

Find a single RecordSet.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_recordsets(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None, force_index=False)

Find RecordSets.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_recordsets_axfr(context, criterion=None)

Find RecordSets.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_service_status(context, criterion)

Find a single Service Status.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_service_statuses(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Retrieve status for services

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_tenants(context)

Find all Tenants.

Parameters

context – RPC Context.

abstract find_tld(context, criterion)

Find a single TLD.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_tlds(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find TLDs

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_tsigkeys(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find TSIG Keys.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_zone(context, criterion)

Find a single Zone.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_zone_export(context, criterion)

Find a single Zone Export.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_zone_exports(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find Zone Exports

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_zone_import(context, criterion)

Find a single Zone Import.

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

abstract find_zone_imports(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find Zone Imports

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract find_zones(context, criterion=None, marker=None, limit=None, sort_key=None, sort_dir=None)

Find zones

Parameters

• context – RPC Context.

• criterion – Criteria to filter by.

• marker – Resource ID from which after the requested page will start after

• limit – Integer limit of objects of the page size after the marker

• sort_key – Key from which to sort after.

• sort_dir – Direction to sort after using sort_key.

abstract get_blacklist(context, blacklist_id)

Get a Blacklist via ID.

Parameters

• context – RPC Context.

• blacklist_id – Blacklist ID to get.

abstract get_pool(context, pool_id)

Get a Pool via the id

Parameters

• context – RPC Context.

• pool_id – The ID of the pool to get

abstract get_pool_attribute(context, pool_attribute_id)

Get a PoolAttribute via the ID

Parameters

• context – RPC Context.

• pool_attribute_id – The ID of the PoolAttribute to get

abstract get_quota(context, quota_id)

Get a Quota via ID.

Parameters

• context – RPC Context.

• quota_id – Quota ID to get.

abstract get_record(context, record_id)

Get a record via ID

Parameters

• context – RPC Context.

• record_id – Record ID to get

abstract get_recordset(context, recordset_id)

Get a recordset via ID

Parameters

• context – RPC Context.

• recordset_id – RecordSet ID to get

abstract get_tenant(context, tenant_id)

Get all Tenants.

Parameters

• context – RPC Context.

• tenant_id – ID of the Tenant.

abstract get_tld(context, tld_id)

Get a TLD via ID.

Parameters

• context – RPC Context.

• tld_id – TLD ID to get.

abstract get_tsigkey(context, tsigkey_id)

Get a TSIG Key via ID.

Parameters

• context – RPC Context.

• tsigkey_id – Server ID to get.

abstract get_zone(context, zone_id)

Get a Zone via its ID.

Parameters

• context – RPC Context.

• zone_id – ID of the Zone.

abstract get_zone_export(context, zone_export_id)

Get a Zone Export via ID.

Parameters

• context – RPC Context.

• zone_export_id – Zone Export ID to get.

abstract get_zone_import(context, zone_import_id)

Get a Zone Import via ID.

Parameters

• context – RPC Context.

• zone_import_id – Zone Import ID to get.

ping(context)

Ping the Storage connection

abstract purge_zone(context, zone)

Purge a Zone

Parameters

• context – RPC Context.

• zone – Zone to delete.

abstract update_blacklist(context, blacklist)

Update a Blacklist

Parameters

• context – RPC Context.

• blacklist – Blacklist to update.

abstract update_pool(context, pool)

Update the specified pool

Parameters

• context – RPC Context.

• pool – Pool to update.

abstract update_pool_attribute(context, pool_attribute)

Update the specified pool

Parameters

• context – RPC Context.

• pool_attribute – PoolAttribute to update

abstract update_quota(context, quota)

Update a Quota

Parameters

• context – RPC Context.

• quota – Quota to update.

abstract update_record(context, record)

Update a record

Parameters

• context – RPC Context.

• record – Record to update

abstract update_recordset(context, recordset)

Update a recordset

Parameters

• context – RPC Context.

• recordset – RecordSet to update

abstract update_service_status(context, service_status)

Update the Service status for a service.

Parameters

• context – RPC Context.

• service_status – Set the status for a service.

abstract update_tld(context, tld)

Update a TLD

Parameters

• context – RPC Context.

• tld – TLD to update.

abstract update_tsigkey(context, tsigkey)

Update a TSIG Key

Parameters

• context – RPC Context.

• tsigkey – TSIG Keyto update.

abstract update_zone(context, zone)

Update a Zone

Parameters

• context – RPC Context.

• zone – Zone object.

abstract update_zone_export(context, zone_export)

Update a Zone Export

Parameters

• context – RPC Context.

• zone_export – Zone Export to update.

abstract update_zone_import(context, zone_import)

Update a Zone Import

Parameters

• context – RPC Context.

• zone_import – Zone Import to update.