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'
add_nameserver_addresses(addrs)
Add a list of nameserver addresses.
| Paramter | Description |
|---|---|
| addrs | A list of nameserver IPs addresses (as strings). |
add_nameserver_domain_names(names)
Add a list of nameserver domain names.
| Paramter | Description |
|---|---|
| names | A list of nameserver domain names. |
add_nameserver_search_domains(domains)
Add a list of nameserver search domains.
| Paramter | Description |
|---|---|
| domains | A list of nameserver search domains. |
add_static_routes(routes)
Add a list of static routes.
| Parameter | Description |
|---|---|
| routes | A list of [network address, mask, gateway] arrays. |
break_xha_pair(break_in_proteus_only)
Break XHA pair.
delete_nameserver_addresses(addrs)
Delete a list of nameserver addresses.
| Parameter | Description |
|---|---|
| addrs | A list of nameserver IPs addresses (as strings). |
delete_nameserver_domain_names(names)
Delete a list of nameserver domain names.
| Parameter | Description |
|---|---|
| names | A list of nameserver domain names. |
delete_nameserver_search_domains(domains)
Delete a list of nameserver search domains.
| Parameter | Description |
|---|---|
| domains | A list of nameserver search domains. |
delete_static_routes(routes)
Delete a list of static routes.
| Parameter | Description |
|---|---|
| routes | A list of [network address, mask, gateway] arrays. |
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_nameservers()
Get a tuple of (addresses, domain names and search domains) for nameservers.
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.
get_static_routes()
Get a dictionary of static routes for a server.
he return value is a dictionary of route IDs to [network address, mask, gateway] arrays.
run_clish(commands)
Run a list of commands on the server using clish. For this work an SSH key pair for root allowing login without the need to enter a password must have been setup.
| Parameter | Description |
|---|---|
| commands | String of clish commands with embedded linefeeds. |
run_psmclient(command, timeout=30)
Execute a PsmClient command on the server. The username and password must be set with set_ssh_credentials, if shared key authentication is not configured.
| Parameter | Description |
|---|---|
| command | String containing PsmClient command to execute. |
| timeout |
Returns the output from the command executed.
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. |
update_nameservers(addresses, domain_names, search_domains)
Update addresses, domain names and search domains for nameservers.
update_static_routes(routes)
Update static routes for a server.
| Parameter | Description |
|---|---|
| routes | A dictionary of route IDs to [network address, mask, gateway] arrays. |
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. |