class documentation

A class to represent a generic DHCP service, inherited from Allocator and used by the DHCP4 and DHCP6 services

Method __dict__ Return a dictionary representation of the service, for making JSON in the format KEA expects
Method __init__ Initialize the object
Method add_client_class Add a client class to the service
Method add_hook_library Add a KEA plugin to the server
Method client_classes.setter set the client classes
Method hook_libraries.setter Set the KEA plugins on this server
Method reservations_global.setter set global reservations. If true, reservations are global, if false, they are not
Method reservations_in_subnet.setter set reservations in subnet. If true, reservations are in subnet, if false, they are not
Method reservations_lookup_first.setter set whether host reservations lookup should be performed before lease lookup
Method reservations_out_of_pool.setter set whether host reservations can be made outside the pool when reservations-in-subnet is true
Method update_service Send the service to the server
Instance Variable control_socket The control socket for the DHCP service
Instance Variable default_nameservers A list of default nameservers for the DHCP service
Instance Variable dhcp_queue_control The DHCP Queue Control Object for the DHCP service
Instance Variable early_global_reservations_lookup Whether to do an early global reservations lookup
Instance Variable expired_leases_processing The Expired Leases Processing object for the DHCP service
Instance Variable global_params A dictionary of global DHCP Options for the DHCP service
Instance Variable host_reservation_identifiers A list of host reservation identifiers
Instance Variable hostname_char_replacement The hostname character replacement because using banned characters is like a sport for some people
Instance Variable hostname_char_set The hostname character set in case you want to put your foot down
Instance Variable interfaces_config The Interfaces Config object for the DHCP service
Instance Variable ip_reservations_unique Whether IP reservations are unique
Instance Variable json_key Initialize a DHCP service object, with empty strings and lists
Instance Variable lease_database The Lease Database object for the DHCP service
Instance Variable loggers A list of Logger objects for the DHCP service
Instance Variable mac_sources A list of MAC sources used by DHCP service
Instance Variable multi_threading The Multi Threading object for the DHCP service, sets the threading options
Instance Variable option_defs A list of DHCP options that define the option definitions used by option_data
Instance Variable relay_supplied_options A list of the DHCP Options supplied by the relay
Instance Variable sanity_checks The Sanity Checks object for the DHCP service, these are the checks that are done to make sure the service is not insane
Instance Variable server_id The Server ID object for the DHCP service
Instance Variable server_tag The server tag for the DHCP service
Instance Variable statistic_default_sample_age The default sample age for statistics
Instance Variable statistic_default_sample_count The default sample count for statistics
Instance Variable store_extended_info Whether to store extended lease info
Instance Variable subnet_ids The IDs used by the subnets in this service, so you don't reuse one and break the world
Instance Variable subnets A list of Subnet objects
Property client_classes the client classes
Property hook_libraries The KEA plugins on this server
Property reservations_global fetch global reservations. If true, reservations are global, if false, they are not
Property reservations_in_subnet fetch reservations in subnet. If true, reservations are in subnet, if false, they are not
Property reservations_lookup_first controls whether host reservations lookup should be performed before lease lookup
Property reservations_out_of_pool controls whether host reservations can be made outside the pool when reservations-in-subnet is true
Instance Variable _client_classes Undocumented
Instance Variable _hook_libraries Undocumented
Instance Variable _reservations_global Undocumented
Instance Variable _reservations_in_subnet Undocumented
Instance Variable _reservations_lookup_first Undocumented
Instance Variable _reservations_out_of_pool Undocumented

Inherited from Allocator:

Method add_option_data Add a DHCP Option object to the list of options sent to leases :param option_data: The DHCP Option object to add, DHCPOption with option_usage set to OPTION_IMPLEMENTATION
Method add_option_def Add a DHCP Option object to the list of options sent to leases :param option_def: The DHCP Option object to add, DHCPOption with option_usage set to OPTION_DEFINITION
Method allocator_type.setter Set the allocator type, making sure it's either an AllocatorType enum or a string that matches one of the AllocatorType values
Method calculate_tee_times.setter Set the calculate tee times flag :param calculate_tee_times: A boolean to determine if tee times should be calculated
Method decline_probation_period.setter Set the probation period for declined leases :param decline_probation_period: The probation period in seconds
Method fill_from_json Fill the object from the JSON dictionary from the KEA web interface :param json_data: The JSON dictionary to fill the object from
Method option_data.setter Set the list of DHCP Option objects to be sent to leases :param option_data: A list of DHCP Option objects, DHCPOption with option_usage set to OPTION_IMPLEMENTATION
Method option_defs.setter Set the list of DHCP Option objects that define the options used by leases :param option_defs: A list of DHCP Option objects, DHCPOption with option_usage set to OPTION_DEFINITION
Method parked_packet_limit.setter Set the parked packet limit :param parked_packet_limit: The max number of packets that can be parked
Method preferred_lifetime.setter Set the preferred lifetime of the lease :param preferred_lifetime: The preferred lifetime of the lease in seconds
Method rebind_timer.setter Set the rebind timer :param rebind_timer: The rebind timer in seconds
Method renew_timer.setter Set the renew timer :param renew_timer: The renew timer in seconds
Method t1_percent.setter Set the T1 percent :param t1_percent: The T1 percent. Should be between 0 and 1
Method t2_percent.setter Set the T2 percent :param t2_percent: The T2 percent. Should be between 0 and 1
Method valid_lifetime.setter Set the valid lifetime of the lease :param valid_lifetime: The valid lifetime of the lease in seconds
Instance Variable allocator_type itterative or randomized. Assign using an AllocatorType enum or string, the object figures it out.
Instance Variable calculate_tee_times Calculate tee times. Default is True
Instance Variable decline_probation_period The probation period for declined leases. Default is 0
Instance Variable option_data A list of DHCP options to be sent with the lease. These contain the settings for the lease
Instance Variable preferred_lifetime The preferred lifetime of the lease. Default is 0
Instance Variable rebind_timer The rebind timer. Default is 0
Instance Variable renew_timer The renew timer. Default is 0
Instance Variable sets_allocator_type Flag to indicate if the allocator type has been set
Instance Variable sets_decline_probation_period Flag to indicate if the probation period for declined leases has been set
Instance Variable sets_preferred_lifetime Flag to indicate if the preferred lifetime has been set
Instance Variable sets_rebind_timer Flag to indicate if the rebind timer has been set
Instance Variable sets_renew_timer Flag to indicate if the renew timer has been set
Instance Variable sets_t1_percent Flag to indicate if the T1 percent has been set
Instance Variable sets_t2_percent Flag to indicate if the T2 percent has been set
Instance Variable sets_tee_times Flag to indicate if tee times have been set
Instance Variable sets_valid_lifetime Flag to indicate if the valid lifetime has been set
Instance Variable t1_percent T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1
Instance Variable t2_percent T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1
Instance Variable valid_lifetime The valid lifetime of the lease. Default is 0
Property parked_packet_limit The max number of packets that can be parked. Default is 0
Instance Variable _allocator_type Undocumented
Instance Variable _calculate_tee_times Undocumented
Instance Variable _decline_probation_period Undocumented
Instance Variable _option_data Undocumented
Instance Variable _option_defs Undocumented
Instance Variable _parked_packet_limit Undocumented
Instance Variable _preferred_lifetime Undocumented
Instance Variable _rebind_timer Undocumented
Instance Variable _renew_timer Undocumented
Instance Variable _t1_percent Undocumented
Instance Variable _t2_percent Undocumented
Instance Variable _valid_lifetime Undocumented
def __dict__(self):

Return a dictionary representation of the service, for making JSON in the format KEA expects

def add_client_class(self, client_class):

Add a client class to the service

def add_hook_library(self, hook_library):

Add a KEA plugin to the server

@client_classes.setter
def client_classes(self, client_classes):

set the client classes

@hook_libraries.setter
def hook_libraries(self, hook_libraries):

Set the KEA plugins on this server

@reservations_global.setter
def reservations_global(self, reservations_global):

set global reservations. If true, reservations are global, if false, they are not

@reservations_in_subnet.setter
def reservations_in_subnet(self, reservations_in_subnet):

set reservations in subnet. If true, reservations are in subnet, if false, they are not

@reservations_lookup_first.setter
def reservations_lookup_first(self, reservations_lookup_first):

set whether host reservations lookup should be performed before lease lookup

@reservations_out_of_pool.setter
def reservations_out_of_pool(self, reservations_out_of_pool):

set whether host reservations can be made outside the pool when reservations-in-subnet is true

def update_service(self, server, ssl=True):

Send the service to the server

control_socket: str =

The control socket for the DHCP service

default_nameservers: list =

A list of default nameservers for the DHCP service

dhcp_queue_control =

The DHCP Queue Control Object for the DHCP service

early_global_reservations_lookup: bool =

Whether to do an early global reservations lookup

expired_leases_processing =

The Expired Leases Processing object for the DHCP service

global_params: dict =

A dictionary of global DHCP Options for the DHCP service

host_reservation_identifiers: list =

A list of host reservation identifiers

hostname_char_replacement: str =

The hostname character replacement because using banned characters is like a sport for some people

hostname_char_set: str =

The hostname character set in case you want to put your foot down

interfaces_config =

The Interfaces Config object for the DHCP service

ip_reservations_unique: bool =

Whether IP reservations are unique

json_key =

Initialize a DHCP service object, with empty strings and lists

lease_database =

The Lease Database object for the DHCP service

loggers: list =

A list of Logger objects for the DHCP service

mac_sources: list[str] =

A list of MAC sources used by DHCP service

multi_threading =

The Multi Threading object for the DHCP service, sets the threading options

option_defs: list =

A list of DHCP options that define the option definitions used by option_data

relay_supplied_options: list =

A list of the DHCP Options supplied by the relay

sanity_checks =

The Sanity Checks object for the DHCP service, these are the checks that are done to make sure the service is not insane

server_id =

The Server ID object for the DHCP service

server_tag: str =

The server tag for the DHCP service

statistic_default_sample_age: int =

The default sample age for statistics

statistic_default_sample_count: int =

The default sample count for statistics

store_extended_info: bool =

Whether to store extended lease info

subnet_ids: list =

The IDs used by the subnets in this service, so you don't reuse one and break the world

subnets: list =

A list of Subnet objects

@property
client_classes =

the client classes

@property
hook_libraries =

The KEA plugins on this server

@property
reservations_global =

fetch global reservations. If true, reservations are global, if false, they are not

@property
reservations_in_subnet =

fetch reservations in subnet. If true, reservations are in subnet, if false, they are not

@property
reservations_lookup_first =

controls whether host reservations lookup should be performed before lease lookup

@property
reservations_out_of_pool =

controls whether host reservations can be made outside the pool when reservations-in-subnet is true

_client_classes =

Undocumented

_hook_libraries =

Undocumented

_reservations_global =

Undocumented

_reservations_in_subnet =

Undocumented

_reservations_lookup_first =

Undocumented

_reservations_out_of_pool =

Undocumented