Server class - Platform - BlueCat Gateway - 20.3.1

Gateway Administration Guide

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

class bdds_server.Server(api, api_entity)

Bases: bluecat.entity.Entity

BlueCat DNS/DHCP Server objects.

CANCELLED= 2

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.

deploy()

Deploy a DNS/DHCP Server.

deploy_services(services=None,force_full_dns=False)

Deploy specific services to a server.

Parameter Description
services List of services to deploy.
force_full_dns 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_server_deployment_status()

Returns the server’s deployment status.

get_service_ip4_address_entities()

Get the list of service IPv4 address entities.

get_service_ip4_addresses()

Get the list of service IPv4 addresses.

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

Set the username and password for SSH connections

Parameter Description
username Login to SSH with this username.
password Login to SSh with this password.

wait_for_deploy(timeout=60, ping_interval=5)

Wait for the server to finish deployment before releasing execution.

Parameter Description
timeout Number of seconds to wait. Raises an api_exception on timeout. Default is 60 seconds.
ping_interval Number of seconds to wait in between each BDDS status check. Default is 5 seconds.