class documentation
A class to represent a subnet in KEA, containing pools of addresses, DHCP options, and other settings
Method | __dict__ |
Return a dictionary representation of the subnet, for making JSON in the format KEA expects |
Method | __init__ |
Initialize a subnet object, with empty strings and lists |
Method | add |
Add a relay to the list of relays |
Method | client |
Set the client class |
Method | fill |
Decode a JSON object into a subnet object |
Method | rapid |
Set the rapid commit setting |
Method | rebind |
Set the renew timer |
Method | relays |
Set the relays |
Method | renew |
Set the renew timer |
Instance Variable | calculate |
Calculate tee times. Default is True |
Instance Variable | client |
Return the client class |
Instance Variable | client |
A client class for the subnet. Mostly a placeholder at this time |
Instance Variable | id |
The ID of the subnet. This must be unique on the server, but the only test so far is that it is not negative |
Instance Variable | interface |
The interface that can allocate addresses from this subnet |
Instance Variable | max |
The maximum preferred lifetime for an address in this subnet |
Instance Variable | max |
The maximum valid lifetime for an address in this subnet |
Instance Variable | min |
The minimum preferred lifetime for an lease in this subnet |
Instance Variable | min |
The minimum valid lifetime for an address in this subnet |
Instance Variable | name |
The name of the subnet |
Instance Variable | pd |
The allocator for the subnet. Like, do the addresses all in a row, or randomize it |
Instance Variable | pools |
A list of Pool objects |
Instance Variable | preferred |
The preferred lifetime of the lease. Default is 0 |
Instance Variable | rapid |
Return the rapid commit setting |
Instance Variable | rebind |
Return the renew timer |
Instance Variable | renew |
Return the renew timer |
Instance Variable | store |
Store extended info about the leases in this subnet |
Instance Variable | subnet |
The type of subnet, subnet_type.v4, subnet_type.v6, or subnet_type.pd |
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 | relays |
Return the relays |
Instance Variable | _client |
Undocumented |
Instance Variable | _client |
Undocumented |
Instance Variable | _rapid |
Undocumented |
Instance Variable | _rapid |
Undocumented |
Instance Variable | _rebind |
Undocumented |
Instance Variable | _rebind |
Undocumented |
Instance Variable | _relays |
Undocumented |
Instance Variable | _relays |
Undocumented |
Instance Variable | _renew |
Undocumented |
Instance Variable | _renew |
Undocumented |
Inherited from Allocator
:
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 | 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 | 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 | 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 | 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 |
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 | _t1 |
Undocumented |
Instance Variable | _t2 |
Undocumented |
Instance Variable | _valid |
Undocumented |
overrides
dhcpy.allocator.Allocator.__dict__
Return a dictionary representation of the subnet, for making JSON in the format KEA expects
overrides
dhcpy.allocator.Allocator.__init__
Initialize a subnet object, with empty strings and lists
id =
¶
The ID of the subnet. This must be unique on the server, but the only test so far is that it is not negative
t1_percent =
¶
overrides
dhcpy.allocator.Allocator.t1_percent
T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1
t2_percent =
¶
overrides
dhcpy.allocator.Allocator.t2_percent
T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1
valid_lifetime =
¶
overrides
dhcpy.allocator.Allocator.valid_lifetime
The valid lifetime of the lease. Default is 0