class documentation

A base class for objects that allocate addresses. This class is not meant to be used directly, but to be inherited by classes that allocate addresses, like the DHCP6 service, the subnet rules, and the pools. These classes share attributes and methods that act like global or specific settings.

You know what, it's early and this makes sense in my head even if I can make it work in words.

Method __dict__ Return a dictionary representation of the object, for making JSON in the format KEA expects
Method __init__ Initialize the object
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 option_defs A list of DHCP options that define the option definitions used by option_data
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 object, for making JSON in the format KEA expects

def __init__(self):
def add_option_data(self, 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

def add_option_def(self, 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

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

Set the allocator type, making sure it's either an AllocatorType enum or a string that matches one of the AllocatorType values

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

Set the calculate tee times flag :param calculate_tee_times: A boolean to determine if tee times should be calculated

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

Set the probation period for declined leases :param decline_probation_period: The probation period in seconds

def fill_from_json(self, json_data):

Fill the object from the JSON dictionary from the KEA web interface :param json_data: The JSON dictionary to fill the object from

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

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

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

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

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

Set the parked packet limit :param parked_packet_limit: The max number of packets that can be parked

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

Set the preferred lifetime of the lease :param preferred_lifetime: The preferred lifetime of the lease in seconds

@rebind_timer.setter
def rebind_timer(self, rebind_timer):
overridden in dhcpy.subnet.Subnet

Set the rebind timer :param rebind_timer: The rebind timer in seconds

@renew_timer.setter
def renew_timer(self, renew_timer):
overridden in dhcpy.subnet.Subnet

Set the renew timer :param renew_timer: The renew timer in seconds

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

Set the T1 percent :param t1_percent: The T1 percent. Should be between 0 and 1

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

Set the T2 percent :param t2_percent: The T2 percent. Should be between 0 and 1

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

Set the valid lifetime of the lease :param valid_lifetime: The valid lifetime of the lease in seconds

@property
allocator_type =

itterative or randomized. Assign using an AllocatorType enum or string, the object figures it out.

@property
calculate_tee_times =
overridden in dhcpy.subnet.Subnet

Calculate tee times. Default is True

@property
decline_probation_period =

The probation period for declined leases. Default is 0

@property
option_data: list =

A list of DHCP options to be sent with the lease. These contain the settings for the lease

@property
option_defs: list =

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

@property
preferred_lifetime =
overridden in dhcpy.subnet.Subnet

The preferred lifetime of the lease. Default is 0

@property
rebind_timer =
overridden in dhcpy.subnet.Subnet

The rebind timer. Default is 0

@property
renew_timer =
overridden in dhcpy.subnet.Subnet

The renew timer. Default is 0

sets_allocator_type: bool =

Flag to indicate if the allocator type has been set

sets_decline_probation_period: bool =

Flag to indicate if the probation period for declined leases has been set

sets_preferred_lifetime: bool =

Flag to indicate if the preferred lifetime has been set

sets_rebind_timer: bool =

Flag to indicate if the rebind timer has been set

sets_renew_timer: bool =

Flag to indicate if the renew timer has been set

sets_t1_percent: bool =

Flag to indicate if the T1 percent has been set

sets_t2_percent: bool =

Flag to indicate if the T2 percent has been set

sets_tee_times: bool =

Flag to indicate if tee times have been set

sets_valid_lifetime: bool =

Flag to indicate if the valid lifetime has been set

@property
t1_percent =
overridden in dhcpy.subnet.Subnet

T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1

@property
t2_percent =
overridden in dhcpy.subnet.Subnet

T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1

@property
valid_lifetime =
overridden in dhcpy.subnet.Subnet

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

_allocator_type =

Undocumented

_calculate_tee_times =

Undocumented

_decline_probation_period =

Undocumented

_option_data =

Undocumented

_option_defs =

Undocumented

_parked_packet_limit =

Undocumented

_preferred_lifetime =

Undocumented

_rebind_timer =
overridden in dhcpy.subnet.Subnet

Undocumented

_renew_timer =
overridden in dhcpy.subnet.Subnet

Undocumented

_t1_percent =

Undocumented

_t2_percent =

Undocumented

_valid_lifetime =

Undocumented