Appendix - Provided Playbooks - Adaptive Plugins - BlueCat Gateway - 23.1

Ansible Module Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.1
Included with the BlueCat Ansible Module is a series of standalone playbooks, split into two categories:
  • BAM
  • BDDS
Below is a table of each provided playbook and its function.

BAM Playbooks

Unless specified, the properties to include in a post or patch action are optional. If included, properties must appear in the json_data. If using default values for the configuration or view inputs, the values do not need to be included in the resource_path, as configured in the Gateway server.

Playbook Function Inputs Example
add_cname_record.yml Creates a CNAME record in the specified DNS zone.
  • resource_path
    • configuration
    • view
    • host_zone_fqdn
  • json_data
    • cname_absolute_name
      • FQDN of CNAME
    • host_absolute_name
      • The host record that CNAME will be linked to
    • cname_ttl
    • cname_properties (optional)
 
ansible-playbook add_cname_record.yml \
-e "configuration=Ansible \
view=Internal \
host_zone_fqdn=demo.com \
cname_absolute_name=alias.demo.com \
host_absolute_name=a1.demo.com \
cname_ttl=3600"
add_configuration.yml Creates a configuration object in Address Manager.
  • json_data
    • configuration
    • config_properties (optional)
 
ansible-playbook add_configuration.yml \
-e "configuration=Ansible"
add_dns_zone.yml Creates a sub-zone object in Address Manager.
  • resource_path
    • configuration
    • view
    • parent_zone
  • json_data
    • zone
      • The name of the zone to be created
    • zone_properties (optional)
 
ansible-playbook add_dns_zone.yml \
-e "configuration=Ansible \
view=Internal \
parent_zone=com \
zone=demo \
zone_properties=deployable=true"
add_external_host_record.yml Creates an external host record for use in a specified view.
  • resource_path
    • configuration
    • view
  • json_data
    • absolute_name
      • FQDN of external host
    • properties (optional)
 
ansible-playbook add_external_host_record.yml \
-e "configuration=Ansible \
view=Internal \
absolute_name=external_host"
add_host_record.yml

Creates a host record in the specified zone.

The provided playbook assumes creation in the default configuration and view.

  • resource_path

    • configuration
    • view
    • zone

  • json_data

    • host_absolute_name
      • FQDN of host record being created
    • host_ip4_address
    • host_ttl
    • host_properties (optional)
 
ansible-playbook add_host_record.yml \
-e "configuration=Ansible \
view=Internal \
host_absolute_name=a1.demo.com \
host_ip4_address=10.0.0.2 \
host_ttl=3600"
add_ip4_block.yml

Creates a block with a specific IP address.

  • resource_path

    • configuration

  • json_data

    • block_name
      • FQDN of block being created
    • block_address
    • block_cidr_notation
    • block_properties (optional)
 
ansible-playbook add_ip4_block.yml \
-e "configuration=Ansible \
block_address=10.0.0.0 \
block_cidr_notation=8 \
block_name=Ansible Demo Block"
add_ip4_network.yml

Creates an IP4 network in the specified IP4 block.

The provided playbook assumes the need to only traverse 3 IP4 blocks to reach the target, but there is no limit to the number of blocks that can be included in the block value.

  • resource_path

    • configuration
    • ip4_parent_block_for_network

  • json_data

    • ip4_network_cidr
    • ip4_network_name
    • ip4_network_properties (optional)
 
ansible-playbook add_ip4_network.yml \
-e "configuration=Ansible \
ip4_parent_block_for_network=10.0.0.0/8 \
ip4_network_cidr=10.0.0.0/24 \
ip4_network_name='Ansible Network'"
add_next_available_ip.yml

Assigns the next available address in the specified IP4 network.

The following are supported values for the action to take:

  • MAKE_DHCP_RESERVED
  • MAKE_RESERVED
  • MAKE_STATIC
The hostinfo value is not used with the MAKE_DHCP_RESERVED action, but it still needs to be provided. For more information on hostinfo, refer to the Address Manager API Guide.

  • resource_path

    • configuration
    • ip4_network_address

  • json_data

    • mac_address
    • hostinfo
    • action
    • ip4_address_properties (optional)
 
ansible-playbook add_next_available_ip.yml \
-e "ip4_network_address=10.0.0.0 \
configuration=Ansible \
mac_address=113333223344 \
hostinfo=a3.demo.com,101146,true,false \
action=MAKE_STATIC"
add_next_available_ip4_network.yml

Creates the next available IP4 network in the specified IP4 block.

The provided playbook assumes the need to only traverse 3 IP4 blocks to reach the target, but there is no limit to the number of blocks that can be included in the block value.

  • resource_path

    • configuration
    • parent_block_for_network

  • json_data

    • network_name
    • num_address
      • The number of addresses in the network, including gateway and broadcast
    • network_properties (optional)
 
ansible-playbook add_next_available_ip4_network.yml \
-e "configuration=Ansible \
parent_block_for_network=10.0.0.0/8 \
num_adddress=256 \
network_name='Ansible Network' \
network_properties=allowDuplicateHost=disable"
add_range_to_network.yml Creates a range of IP addresses for the specified network.

  • resource_path

    • configuration
    • ip4_network_cidr

  • json_data

    • range_start (optional)
    • range_end (optional)
    • offset (optional)
    • size (optional)
    • template (optional)
    • ip4_network_properties (optional)
 
ansible-playbook add_range_to_network.yml \
-e "configuration=Ansible \
ip4_network_cidr=10.0.0.0/24 \
range_start=10.0.0.5 \
range_end=10.0.0.50"
add_tld_zone.yml Creates a top-level zone object in Address Manager.

  • resource_path

    • configuration
    • view

  • json_data

    • tld
    • zone_properties (optional)
 
ansible-playbook add_tld_zone.yml \
-e "configuration=Ansible \
view=Internal \
tld=com \
zone_properties=deployable=False"
add_view.yml Add a new view in Address Manager.

  • resource_path

    • configuration

  • json_data

    • view
    • view_properties (optional)
 
ansible-playbook add_view.yml \
-e "view=Internal \
configuration=Ansible"
delete_cname.yml Deletes a CNAME record from the specific view.

  • resource_path

    • configuration
    • view
    • absolute_name
      • FQDN of CNAME

  • json_data

    • view
    • view_properties (optional)
 
ansible-playbook delete_cname.yml \
-e "configuration=Ansible \
view=Internal \
absolute_name=alias.demo.com"
delete_external_host_record.yml Deletes an external host record from the specified view.

  • resource_path

    • configuration
    • view
    • absolute_name
      • FQDN of external host
 
ansible-playbook delete_external_host_record.yml \
-e "configuration=Ansible \
view=Internal \
absolute_name=external_host"
delete_host_record.yml

Deletes a specified host record.

The provided playbook assumes the host record is in the default configuration and view.
  • resource_path
    • configuration
    • view
    • absolute_name
      • FQDN of external host
 
ansible-playbook delete_host_record.yml \
-e "configuration=Ansible \
view=Internal \
absolute_name=a1.demo.com"
get_cname_record.yml Returns the Address Manager entity for the specified CNAME.

The provided playbook assumes the zone is in the default configuration and view.
  • resource_path
    • configuration
    • view
    • cname_absolute_name
 
ansible-playbook get_cname_record.yml \
-e "configuration=Ansible \
view=Internal \
cname_absolute_name=alias.demo.com"
get_configuration.yml Returns an Address Manager entity the specified configuration.
  • resource_path
    • configuration
 
ansible-playbook get_configuration.yml \
-e "configuration=Ansible"
get_configurations.yml Returns an Address Manager entity for each configuration in Address Manager. None 
ansible-playbook get_configurations.yml
get_dns_zone.yml

Returns an Address Manager entity for the specified zone.

The provided playbook assumes the zone is in the default configuration and view.

  • resource_path

    • configuration
    • view
    • zone_fqdn
 
ansible-playbook get_dns_zone.yml \
-e "configuration=Ansible \
view=Internal \
zone_fqdn=demo.com"
get_dns_zones.yml

Returns an Address Manager entity for each zone under the specified zone.

The provided playbook assumes the zone is in the default configuration and view.
  • resource_path
    • configuration
    • view
    • zone_fqdn
 
ansible-playbook get_dns_zones.yml \
-e "configuration=Ansible \
view=Internal \
zone_fqdn=com"
get_host_record.yml

Returns an Address Manager entity for the specified host.

The provided playbook assumes the host is in the default configuration and view.

  • resource_path

    • configuration
    • view
    • zone
    • host_absolute_name
      • FQDN of host record
 
ansible-playbook get_host_record.yml \
-e "configuration=Ansible \
view=Internal \
host_absolute_name=a1.demo.com"
get_ip4_block.yml

Returns an Address Manager entity for the specified IP4 block.

The provided playbook assumes the IP4 block is in the default configuration.
  • resource_path
    • configuration
    • block_cidr_notation
 
ansible-playbook get_ip4_block.yml \
-e "configuration=Ansible \
block_cidr_notation=10.0.0.0/8"
get_ip4_blocks.yml

Returns an Address Manager entity for each IP4 block under the specified IP4 block.

The provided playbook assumes the IP4 block is in the default configuration.
  • resource_path
    • configuration
    • block_cidr_notation
 
ansible-playbook get_ip4_blocks.yml \
-e "configuration=Ansible \
block_cidr_notation=10.0.0.0/8"
get_ip4_network.yml Returns an Address Manager entity for the specified IP4 network.

  • resource_path

    • configuration
    • ip4_network_cidr
 
ansible-playbook get_ip4_network.yml \
-e "configuration=Ansible \
ip4_network_cidr=10.0.0.0/24"
get_ip4_networks.yml

Returns an Address Manager entity for each IP4 network under the specified IP4 block.

The provided playbook assumes the IP4 block is in the default configuration.

  • resource_path

    • configuration
    • block_cidr_notation
 
ansible-playbook get_ip4_networks.yml \
-e "configuration=Ansible \
block_cidr_notation=10.0.0.0/8"
get_next_available_ip.yml Returns an Address Manager entity for the next available IP address in the specified IP4 network.

  • resource_path

    • configuration
    • ip4_network_address
 
ansible-playbook get_next_available_ip.yml \
-e "ip4_network_address=10.0.0.0 \
configuration=Ansible"
get_view.yml Returns an Address Manager entity for the specified view.

  • resource_path

    • configuration
    • view
 
ansible-playbook get_view.yml \
-e "view=Internal \
configuration=Demo"
patch_host_record.yml

Updates the specified host record with a new IP address, TTL, or property.

The provided playbook assumes the host is in the default configuration and view.

  • resource_path

    • configuration
    • view
    • host_absolute_name
      • FQDN of host record

  • json_data

    • host_ip4_address
    • host_ttl
    • host_properties
 
ansible-playbook patch_host_record.yml \
-e "configuration=Ansible \
view=Internal \
host_absolute_name=a1.demo.com \
host_ip4_address=10.0.0.2 \
host_ttl=3600"
query_dns.yml Uses the dnspython library to execute DNS queries. N/A See playbook for scripting example
reserve_ip.yml Assigns the specified IP4 address as DHCP Reserved.

  • resource_path

    • configuration
    • ipv4_address

  • json_data

    • mac_address
    • hostinfo
    • name
    • ip4_address_properties
 
ansible-playbook reserve_ip.yml \
-e "configuration=Ansible \
ipv4_address=10.0.0.3 \
mac_address=112233445566 \
hostinfo=a2.demo.com,100895,true,false \
ip4_address_properties=udf_security=test \
name=name test"
search_for_hosts_by_hint.yml

Searches Address Manager for host records matching the provided hint.

The host_hint value accepts the following basic regex characters:

  • ^
  • $
  • ?
  • *

  • resource_path

    • configuration
    • view
    • keyword
 
ansible-playbook search_for_hosts_by_hint.yml \
-e "configuration=Ansible \
view=Internal \
keyword=a1"
search_for_objects.yml

Searches Address Manager for objects of any supported type that match the provided keyword, filtering on property values.

Only the first 1000 results will be returned.

The search_filters must be a list of property=value pairs, separated by commas or “/search/”.

For more information on supported object types, refer to the Address Manager API Guide.

The search_pattern value accepts the following basic regex characters:

  • ^
  • $
  • ?
  • *

  • resource_path

    • keyword
    • object_type
    • search_filters (optional)
 
ansible-playbook search_for_objects.yml \
-e "keyword=Ansible \
object_type=IP4Block"

BDDS Playbooks

The following playbooks allow for the automation of some configuration tasks in a DNS/DHCP Server and require the server be included in the list of inventory hosts. All listed inputs are mandatory.

Playbook Function Inputs
add_name_server.yml Adds a name server to the name server configuration via the Admin CLI and updates the resolv.conf file.
  • name_server_ip
    • The IP of a name server to add
change_ip_address.yml

Modifies the IP address of the DNS/DHCP Server.

Prior to executing this playbook, you must first either disable the server in Address Manager or execute the remove_server_from_BAM_control.yml playbook. The server will also need to be replaced in Address Manager to re-establish proper management connectivity.

Note:
  • This playbook should be used in conjunction with the set_default_gateway.yml playbook to ensure proper connectivity
  • This playbook does not support modifying the IP of a node in an XHA cluster.
  • if_num
    • A number to identify the interface being modified. Typically, the value is 0.
  • ip
    • The new IP address to configure
  • net_bits
    • The subnet mask in CIDR format. For example, a subnet mask of 255.255.255.0 will be represented as the number 24.
custom_ntp.yml

Replaces the default ntp.conf file with a custom configuration.

If you are managing service configuration from Address Manager, the NTP service will indicate it is in manual override. Any updates from Address Manager will overwrite the custom configuration.
  • src
    • The path the playbook will use to find the custom ntp.conf
custom_syslog.conf

Adds a custom syslog configuration to the default configuration.

If a custom configuration directory already exists, there is no requirement to create a new one – multiple configuration files can be included in a single directory.
  • conf_directory
    • The syslog configuration directory to create that will contain the new custom configuration file(s)
  • src
    • The path the playbook will use to find the custom configuration file
license.server.yml

Updates the license information of a virtual DNS/DHCP Server. A valid license is required for deployment and management of virtual servers.

If you are unsure of your license information, contact BlueCat Customer Care or your BlueCat Account Executive.
  • client_id
    • Client ID provided when the licensing information was received
  • license_key
    • License key provided when the licensing information was received
remove_name_server.yml Removes a name server from the name server configuration via the Admin CLI and updates the resolv.conf file.
  • name_server_ip
    • The IP of a name server to remove
remove_server_from_BAM_control.yml

Breaks the management connection between Address Manager and the affected server and should only be used if modifying an IP address of a managed server or after a server has been disabled in Address Manager.

Note: This playbook does not support removing XHA cluster nodes from Address Manager control.

  • resource_path

    • configuration
    • block

  • json_data

    • name
    • size
      • the number of addresses in the network, including gateway and broadcast
set_default_gateway.yml

Configures the default gateway for the services interface through the Admin CLI and updates routes as appropriate.

Note: This playbook should be used in conjunction with the change_ip_address.yml playbook to ensure proper connectivity.

  • gateway_ip

    • IP address of the gateway to use for the services interface (eth0)
set_time_zone.yml

Updates the server’s time zone through the Admin CLI, including the required reboot to complete the change.

The accompanying time_zones.csv file can be used to determine the required values.

For example, the values for setting the time zone to Eastern Time (Toronto) are:

  • continent: 2
  • country: 10
  • region: 7

  • continent

    • A number selected from the Continent column of the time_zones.csv file
  • country
    • A number selected from the Country column of the time_zones.csv file
    • Remove the {{ country }}\n portion if there is no country to select (for example, when using continent 10 or 11)
  • region
    • A number selected from the region column of the time_zones.csv file
    • Remove the {{ region }}\n portion if there is no region to select