DHCPDeploymentRole class - Platform - BlueCat Gateway - 18.2.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
18.2.1
Note: This class is not inherited from APIObject or from Entity.

classdeployment_role.DHCPDeploymentRole(api, api_entity)

Bases: deployment_role.DNSDHCPDeploymentRole

DHCP Deployment role.

AD_MASTER= 'AD_MASTER'

DHCP= 'DHCP'

DHCPv6= 'DHCPv6'

DNS= 'DNS'

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.

Parameter Description
name  

Returns: True or False.

delete()

Delete the DHCP deployment role from the BAM database.

dump()

Dump out details of the deployment role to stdout. Useful for debug.

get_entity_id()

Get the BAM ID of an entity.

get_id()

Get the BAM ID of a deployment role.

get_properties()

Get the properties of the deployment role in the form of a dictionary containing one entry per property.

get_property(name)

Get a single named property for the deployment role or None if not defined.

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 type of the deployment role.

get_type()

Get the BAM type of the deployment role.

get_url()

Get URL.

is_null()

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

populate_from_api_entity(api_entity)

Populate class properties from inner BAM API object.

set_property(name, value)

Set a property value. The change is not persisted until update() is called.

set_type(new_type)

Set the BAM type of the deployment role.

update()

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