Zone class - Platform - BlueCat Gateway - 18.10.2

Gateway Administration Guide
prodname
BlueCat Gateway
version_custom
18.10.2

DNS zone object.

classzone.Zone(api, api_entity)

Bases: bluecat.dns.DNS

Instantiate a DNS zone object.

Parameter Description
api API instance used by the entity to communicate with BAM.
api_entity The entity returned by the BAM API.

ALLOW_QUERY= 'allow-query'

add_dns_deployment_option(dns_option, value, properties='')

Parameter Description
dns_option The name of the DNS option being added.
value The value being assigned to the option.
properties Adds object properties, including comments and user-defined fields.
Returns: Instance of the DNSOption added.

add_dns_deployment_role(server_interface, role_type, properties='')

Adds a DNS deployment role to a specified object.

Parameter Description
server_interface The object ID/server interface object to which the role is to be added.
role_type The type of DNS role to be added. The type must be one of: NONE MASTER MASTER_HIDDEN SLAVE SLAVE_STEALTH FORWARDER STUB RECURSION AD_MASTER.
properties Adds object properties, including the view associated with this DNS deployment role and user-defined fields.
Returns: Added DNS deployment role object.

add_zone(absolute_name, deployable=False, template=0, **kwargs)

Adds DNS zones. You can use . (dot) characters to create the top level domain and subzones.

Parameter Description
absolute_name Fully qualified name of the DNS zone to add (eg. example.com).
deployable Boolean. The default is False.
template ID of the associated network template.
kwargs Keyword arguments of user-defined fields and values.
Returns: Zone instance of the new DNS zone.

get_configuration()

Return the parent Configuration object.

get_dns_deployment_option(dns_option, server)

Parameter Description
dns_option The name of the DNS option.
server Specifies the server to which this option is assigned.
Returns: An instance of the type DNSOption that represents the DNS deployment option.

get_dns_deployment_role(server_interface)

Retrieves a DNS deployment role from a specified object.

Parameter Description
server_interface The object ID/server interface object to which the DNS deployment role is assigned.

get_full_name()

Get absolute name.

Returns: The absolute name of the zone.

get_server_interface_id()

Returns: Server Interface Id.

get_service()

Returns: DeploymentServices enum service type.

get_zone(name)

Get an immediate child zone by name without dot character.
Parameter Description
name Name of the child zone.
Returns: Instance of the child zone or None.

get_zones()

Get all immediate child zones.

Returns: Iterator for Zone entities.