DNSDeploymentRole class - Platform - BlueCat Gateway - 22.4.1

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.4.1

class bluecat.deployment_role.DNSDeploymentRole(api, api_entity)

Bases: bluecat.deployment_role.DNSDHCPDeploymentRole

DNS Deployment role.

This class inherits from APIObject, not Entity.

AD_MASTER = 'AD_MASTER'

DHCP = 'DHCP'

DHCPv6 = 'DHCPv6'

FORWARDER = 'FORWARDER'

MASTER = 'MASTER'

MASTER_HIDDEN = 'MASTER_HIDDEN'

NONE = 'NONE'

RECURSION = 'RECURSION'

SLAVE = 'SLAVE'

SLAVE_STEALTH = 'SLAVE_STEALTH'

STUB = 'STUB'

TFTP = 'TFTP'

before_update()

Hook used in before updating in derived classes

correct_name(name)

This method verify that ‘name’ exist in constants.

Parameters Description
name  

Returns: True/False

delete()

Delete the DNS deployment role from the BAM database.

get_entity_id()

Get the BAM ID of an entity.

get_id()

Get the BAM ID of a deployment role.

get_names()

Return a list of names of the defined elements (constants).

Returns: A list of names of the defined ‘constants’.

Return type: list

get_server()

Get the server associated with a role or None if none exists.

get_server_interface_id()

Get the server interface id.

get_service()

Get the BAM service type for the deployment role. See DeploymentServices() for possible return values.

get_type()

Get the BAM type of the deployment role.

get_url()

Get URL

get_values()

Return a list of values of the defined elements (constants).

Returns: A list of values of the defined ‘constants’.

Return type: list

is_null()

Is this the null entity? (ID == 0).

is_valid_name(name)

Report whether the class has a defined element (constant) with the specified name.

Parameters Description
name(str) The name to be validated as defined in the referenced class.

Returns: Whether there is a defined ‘constant’ with the specified name.

Return type: bool

is_valid_value(value)

Report whether the class has a defined element (constant) with the specified value.

Parameters Description
value(any) The value to be validated that belongs to the referenced class.

Returns: Whether there is a defined ‘constant’ with the specified value.

Return type: bool

populate_from_api_entity(api_entity)

Populate class properties from inner BAM API object

roles = ['MASTER', 'MASTER_HIDDEN', 'SLAVE', 'FORWARDER', 'NONE', 'RECURSION', 'SLAVE', 'SLAVE_STEALTH', 'STUB', 'AD_MASTER']

set_type(new_type)

Set the BAM type of the deployment role.

update()

Persist any changes to the deployment role to the BAM database.