class Allocator(object):
Known subclasses: dhcpy.ClientClass.ClientClass
, dhcpy.dhcp_service.DhcpService
, dhcpy.subnet.Subnet
Constructor: Allocator()
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 |
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 |
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 |
Set the allocator type, making sure it's either an AllocatorType enum or a string that matches one of the AllocatorType values |
Method | calculate |
Set the calculate tee times flag :param calculate_tee_times: A boolean to determine if tee times should be calculated |
Method | decline |
Set the probation period for declined leases :param decline_probation_period: The probation period in seconds |
Method | fill |
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 |
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 |
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 |
Set the parked packet limit :param parked_packet_limit: The max number of packets that can be parked |
Method | preferred |
Set the preferred lifetime of the lease :param preferred_lifetime: The preferred lifetime of the lease in seconds |
Method | rebind |
Set the rebind timer :param rebind_timer: The rebind timer in seconds |
Method | renew |
Set the renew timer :param renew_timer: The renew timer in seconds |
Method | t1 |
Set the T1 percent :param t1_percent: The T1 percent. Should be between 0 and 1 |
Method | t2 |
Set the T2 percent :param t2_percent: The T2 percent. Should be between 0 and 1 |
Method | valid |
Set the valid lifetime of the lease :param valid_lifetime: The valid lifetime of the lease in seconds |
Instance Variable | allocator |
itterative or randomized. Assign using an AllocatorType enum or string, the object figures it out. |
Instance Variable | calculate |
Calculate tee times. Default is True |
Instance Variable | decline |
The probation period for declined leases. Default is 0 |
Instance Variable | option |
A list of DHCP options to be sent with the lease. These contain the settings for the lease |
Instance Variable | option |
A list of DHCP options that define the option definitions used by option_data |
Instance Variable | preferred |
The preferred lifetime of the lease. Default is 0 |
Instance Variable | rebind |
The rebind timer. Default is 0 |
Instance Variable | renew |
The renew timer. Default is 0 |
Instance Variable | sets |
Flag to indicate if the allocator type has been set |
Instance Variable | sets |
Flag to indicate if the probation period for declined leases has been set |
Instance Variable | sets |
Flag to indicate if the preferred lifetime has been set |
Instance Variable | sets |
Flag to indicate if the rebind timer has been set |
Instance Variable | sets |
Flag to indicate if the renew timer has been set |
Instance Variable | sets |
Flag to indicate if the T1 percent has been set |
Instance Variable | sets |
Flag to indicate if the T2 percent has been set |
Instance Variable | sets |
Flag to indicate if tee times have been set |
Instance Variable | sets |
Flag to indicate if the valid lifetime has been set |
Instance Variable | t1 |
T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1 |
Instance Variable | t2 |
T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1 |
Instance Variable | valid |
The valid lifetime of the lease. Default is 0 |
Property | parked |
The max number of packets that can be parked. Default is 0 |
Instance Variable | _allocator |
Undocumented |
Instance Variable | _calculate |
Undocumented |
Instance Variable | _decline |
Undocumented |
Instance Variable | _option |
Undocumented |
Instance Variable | _option |
Undocumented |
Instance Variable | _parked |
Undocumented |
Instance Variable | _preferred |
Undocumented |
Instance Variable | _rebind |
Undocumented |
Instance Variable | _renew |
Undocumented |
Instance Variable | _t1 |
Undocumented |
Instance Variable | _t2 |
Undocumented |
Instance Variable | _valid |
Undocumented |
dhcpy.ClientClass.ClientClass
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
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
Set the allocator type, making sure it's either an AllocatorType enum or a string that matches one of the AllocatorType values
Set the calculate tee times flag :param calculate_tee_times: A boolean to determine if tee times should be calculated
Set the probation period for declined leases :param decline_probation_period: The probation period in seconds
dhcpy.ClientClass.ClientClass
, dhcpy.subnet.Subnet
Fill the object from the JSON dictionary from the KEA web interface :param json_data: The JSON dictionary to fill the object from
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
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
Set the parked packet limit :param parked_packet_limit: The max number of packets that can be parked
Set the preferred lifetime of the lease :param preferred_lifetime: The preferred lifetime of the lease in seconds
dhcpy.subnet.Subnet
Set the rebind timer :param rebind_timer: The rebind timer in seconds
dhcpy.subnet.Subnet
Set the renew timer :param renew_timer: The renew timer in seconds
Set the valid lifetime of the lease :param valid_lifetime: The valid lifetime of the lease in seconds
dhcpy.dhcp_service.DhcpService
A list of DHCP options that define the option definitions used by option_data
dhcpy.subnet.Subnet
T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1
dhcpy.subnet.Subnet
T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1