Configuration class - Platform - BlueCat Gateway - 24.1

Click a link to jump to the indicated section.

• Configuration class

  • Configuration.GLOBAL_UNICAST_PREFIX

  • Configuration.MAX_COUNT

  • Configuration.UNIQUE_LOCAL_PREFIX

  • add_ip4_block_by_cidr()

  • add_ip4_block_by_range()

  • add_mac_address()

  • add_raw_deployment_option()

  • add_response_policy()

  • add_server()

  • add_tftp_group()

  • add_view()

  • assign_ip4_address()

  • assign_ip6_address()

  • assign_next_available_ip4_address()

  • create_xha_pair()

  • find_response_policy_with_item()

  • get_deployment_options()

  • get_entity_by_cidr()

  • get_host_records_by_ip()

  • get_ip4_address()

  • get_ip4_blocks()

  • get_ip4_networks_by_hint()

  • get_ip6_address()

  • get_ip6_global_unicast_block()

  • get_ip6_objects_by_hint()

  • get_ip6_unique_local_block()

  • get_ip_range_by_ip()

  • get_ip_ranged_by_ip()

  • get_mac_address()

  • get_next_available_ip4_address()

  • get_next_available_ip4_network()

  • get_next_available_ip_range()

  • get_next_available_ip_ranges()

  • get_next_ip4_address()

  • get_next_ip4_address_string()

  • get_server()

  • get_servers()

  • get_tsig_keys()

  • get_view()

  • get_views()

  • get_zones_by_hint()

  • is_address_allocated()

  • is_ip4_address_allocated()

class bluecat.configuration.Configuration(api, api_entity)

Bases: bluecat.configuration.IP4SpaceConfiguration bluecat.configuration.IP4SpaceConfigurationBlockNet bluecat.configuration.IP4SpaceConfigurationNet bluecat.configuration.IP6SpaceConfiguration bluecat.configuration.IP6SpaceConfigurationBlockNet bluecat.configuration.DNSConfiguration bluecat.configuration.ServerConfiguration bluecat.deployment_option.RawDeploymentOptionActionsMixin

The configuration class wraps the BAM Configuration Entity type. Generally, most API use cases start with retrieving one or more configurations from where other object types may be retrieved.

GLOBAL_UNICAST_PREFIX = '2000::/3'

MAX_COUNT = 1000

UNIQUE_LOCAL_PREFIX = 'FC00::/6'

add_ip4_block_by_cidr(cidr, properties='')

Create a new ip4 child block using CIDR.

Returns: Returns an APIEntity for the created IPv4 block object.

add_ip4_block_by_range(start, end, properties='')

Create a new ip4 child block by defining an address range.

Returns: Returns an APIEntity for the created IPv4 block object.

add_mac_address(address, name='', mac_pool=None, properties='')

Adds a mac address object.

Returns: The added MAC address object.

add_raw_deployment_option(option_type, raw_data, properties='')

Returns: Returns an instance of the type DNSOption that represents the DNS deployment option.

add_response_policy(name, policy_type, ttl=300, properties='')

Adds a response policy to the configuration.

Returns: The policy object that was added.

Return type: bluecat.response_policy.ResponsePolicy

Example:

from bluecat.constants import ResponsePolicy

api = g.user.get_api()                                   # get api object
configuration_id = 100001                                # configuration id
config = api.get_entity_by_id(configuration_id)

policy = config.add_response_policy('testpolicy',
                                     ResponsePolicy.WHITELIST,
                                     ttl=200, properties='test')

add_server(name, address, host_name, profile=ServerCapabilityProfiles.DNS_DHCP_GEN4_2000, properties='password=bluecat|connected=true|upgrade=False')

Returns: Server entity added.

add_tftp_group(name, properties='')

Returns: TFTPGroup entity added.

add_view(name, properties='')

Add View

Returns: An instance of the created View

assign_ip4_address(address, mac_address, hostinfo, action, properties='')

Assign an IPv4 address (e.g. ‘192.168.0.1’).

Returns: Returns an APIEntity for the assigned IPv4 address object.

assign_ip6_address(action, address, mac_address='', hostinfo='', duid='', properties='')

Assign an IPv6 address

Returns: Returns the updated IPv6Address

assign_next_available_ip4_address(mac_address, hostinfo, action, properties='')

Assigns next available IPv4 address.

Returns: Returns an APIEntity for the assigned IPv4 address object.

create_xha_pair(active_server, passive_server, active_server_new_ip, properties='', max_wait=1200)

Returns: Active BDDS server entity object if successful. Exception on failure.

find_response_policy_with_item(item_name, properties='')

Get the response policies that contain an item with the specified name.

Returns: Returns an array of response policy with the item_name in them.

Example:

api = g.user.get_api()                                   # get api object
configuration_id = 100001                                # configuration id
config = api.get_entity_by_id(configuration_id)

policy_list = config.find_response_policy_with_item('testpolicy')

get_deployment_options(option_types, server)

Get deployment Option for the entity.

get_entity_by_cidr(cidr, entity_type='IP4Block')

Returns an IPv4 Block object by calling the block using CIDR notation.

Returns: The specified IPv4 block object from the database.

get_host_records_by_ip(ip4_objects, version=1)

Use this method to find Host Records associated with a set of IPv4 addresses.

Returns: Returns a generator that yields tuples, where each tuple contains an IPv4 address object and the list of Host Records objects associated with it.

Raises:

• BAMException – If there is an exception in retrieving host records.

• PortalException – If BAM version is lower than 9.0.0.

• PortalException – If version is not supported

Example:

api = g.user.get_api()                          # get api object
configuration = api.get_configuration('config') # get configuration object
ip4_address = api.get_entity_by_id(101873)      # IP4 address objects to search

for ip_address in configuration.get_host_records_by_ip([ip4_address]):
    for host in ip_address[1]:
        print(host)

get_ip4_address(address)

Get an IPv4 address by IP (e.g. ‘192.168.0.1’).

Returns: Returns the requested APIEntity of IPv4 Address object.

get_ip4_blocks()

Get the IPv4 blocks directly underneath the current configuration or block. Note that blocks form the nodes of a tree with networks being the leaves.

Returns: Returns an iterator of DHCPv4 range objects from the database.

get_ip4_networks_by_hint(ip_prefix)

Search for IPv4 networks using their ip prefix in the configuration or block. Returns an array of IPv4 networks found under the container object. Currently only allows hints using ip prefix.

Returns: Returns an array of IPv4 networks based on the input argument or returns an empty list if no results are found.

get_ip6_address(address)

Get an IPv6 Address

get_ip6_global_unicast_block()

Return the IPv6 global unicast address space block

get_ip6_objects_by_hint(hint, access_right='', count=10)

Gets an array of IPv6 objects.

Example:

from bluecat.constants import AccessRightValues

api = g.user.get_api()                                   # get api object
configuration_id = 100001                                # configuration id
config = api.get_entity_by_id(configuration_id)

ip6_networks = config.get_ip6_objects_by_hint('2001', access_right=AccessRightValues.AddAccess,
                                             count=10)
for network in ip6_networks:
    print(network)

get_ip6_unique_local_block()

Return the IPv6 unique local address space block

get_ip_range_by_ip(entity_type, address)

Use this method to find the Configuration, IPv4 Block, IPv6 Block, IPv4 Network, IPv6 Network, DHCP Range, or DHCPv6 range containing a specified address. You can specify the type of object to be returned, or you can leave the type of object empty to find the most direct container for the object.

Returns: Returns an APIEntity for the object containing the specified address. If EntityType.IP4Block, EntityType.IP6Block, EntityType.IP4Network, EntityType.IP6Network, EntityType.DHCP4Range, or EntityType.DHCP6Range is specified as the type parameter, returns an object of the specified type. If an empty string (“”) is specified as the type parameter, returns the most direct container for the IPv4 address or IPv6 address.

Raises:

PortalException – if no object matching the entity_type and address is found.

get_ip_ranged_by_ip(entity_type, address)

Use this method to find the Configuration, IPv4 Block, IPv6 Block, IPv4 Network, IPv6 Network, DHCP Range, or DHCPv6 range containing a specified address. You can specify the type of object to be returned, or you can leave the type of object empty to find the most direct container for the object.

Returns: Returns an APIEntity for the object containing the specified address. If EntityType.IP4Block, EntityType.IP6Block, EntityType.IP4Network, EntityType.IP6Network, EntityType.DHCP4Range, or EntityType.DHCP6Range is specified as the type parameter, returns an object of the specified type. If an empty string (“”) is specified as the type parameter, returns the most direct container for the IPv4 address or IPv6 address.

Raises:

PortalException – if no object matching the entity_type and address is found.

get_mac_address(address)

Retrieves a MAC address object by MAC address.

Returns: The MAC address object.

get_next_available_ip4_address()

Gets next available IPv4 address in current configuration

Returns: Returns the next available IPv4 address in an existing network as a string.

get_next_available_ip4_network(size, is_larger_allowed=False, auto_create=True)

Returns the next available (unused) network within a configuration or block.

Returns: Returns the next available (unused) network or None.

get_next_available_ip_range(size, entity_type, properties='')

• was set to true, the newly created IPv4 range.

Returns: Returns the next available (unused) block or network within a configuration or block.

get_next_available_ip_ranges(size, max_results, properties='')

Finds or creates unused IPv4 Networks of the specified size.

Returns: A list of newly created IPv4Networks.

get_next_ip4_address(exclude=None)

Get the next available IPv4 address (as a string) optionally excluding a given list of addresses.

get_next_ip4_address_string(exclude=None)

Get the next available IPv4 address (as a string) optionally excluding a given list of addresses.

get_server(name)

Get a named server. Returns None if the server wasn’t found.

get_servers()

Get a list of all the servers in a configuration.

get_tsig_keys(start=0, count=100)

List TSIG keys defined within the configuration.

Returns: An iterable of instances of TSIGKey.

Return type: Iterable[TSIGKey]

Example:

api = g.user.get_api()     # a user-aware bluecat.api.API instance
configuration_id = 100001  # ID of a Configuration
configuration = api.get_entity_by_id(configuration_id)

keys = configuration.get_tsig_keys(start=0, count=10)

for key in keys:
    print(key.name)

New in version 20.3.1.

get_view(name)

Get a named view (ref: split horizon DNS) out of a configuration. An exception is raised if the view doesn’t exist.

get_views()

Get an Iterator for all child views (ref: split horizon DNS) of the configuration.

Returns: Iterator for View entities

get_zones_by_hint(hint)

Get an array of accessible zones under the configuration.

Returns: Returns an array of any zones (the FQDN of the zone) that match the given hint as data in JSON, using the result template format. The array contains a maximum of 10 elements.

is_address_allocated(address, mac_address)

Checks if an IPv4 address is allocated in the current configuration.

Returns: True/False

is_ip4_address_allocated(address, mac_address)

Checks if an IPv4 address is allocated in the current configuration.

Returns: True/False