Server class - Platform - BlueCat Gateway - 24.3.3

Gateway Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
24.3.3

class bluecat.bdds_server.Server(api, api_entity)

Bases: bluecat.entity.Entity bluecat.deployment_option.RawDeploymentOptionActionsMixin

BlueCat DNS/DHCP Server objects.

CANCELLED = 2

CANCELLING = 9

DHCP = 'DHCP'

DHCPv6 = 'DHCPv6'

DNS = 'DNS'

DONE = 7

EXECUTING = -1

FAILED = 3

INITIALIZING = 0

INVALID = 6

NOT_DEPLOYED = 4

NO_RECENT_DEPLOYMENT = 8

QUEUED = 1

TFTP = 'TFTP'

WARNING = 5

break_xha_pair(break_in_proteus_only)

Break XHA pair.

Parameters Description
break_in_proteus_only (bool)

deploy()

Deploy a DNS/DHCP Server.

deploy_services(services=None, force_full_dns=False)

Deploy specific services to a server.

Parameters Description
services (list, optional)

List of services to deploy.

force_full_dns (bool, optional)

Force a full deployment if true. Note that this actually means just send the full data to the server. What happens to the service itself will depend on whether or not its running at the time.

failover_xha()

Failover XHA

get_deployment_roles(types=None)

Get deployment roles for the server.

Parameters Description
types (list, optional)

An optional list of deployment role types (documented in the deployment_role class). If the list is empty all types are returned.

Return type: list

get_server_deployment_status()

Returns the server’s deployment status.

Return type: int

get_service_ip4_address_entities()

Get the list of service IPv4 address entities.

Return type: list

get_service_ip4_addresses()

Get the list of service IPv4 addresses.

Return type: list

set_ssh_credentials(username='', password='')

Set the username and password for SSH connections

Parameters Description
username (str, optional)

Login to SSH with this username.

password (str, optional)

Login to SSh with this password.

wait_for_deploy(timeout=60, ping_interval=5)

Wait for the server to finish deployment before releasing execution.

Parameters Description
timeout (int, optional)

Number of seconds to wait. Raises api_exception on timeout. Default is 60s

ping_interval (int, optional)

Number of seconds to wait in between each BDDS status check. Default is 5s