class documentation
A class to represent a DHCP4 service, inherited from DhcpService
Method | __init__ |
Initialize a DHCP4 service object, with empty strings and lists |
Instance Variable | control |
The control socket for the DHCP4 service |
Inherited from DhcpService
:
Method | __dict__ |
Return a dictionary representation of the service, for making JSON in the format KEA expects |
Method | add |
Add a client class to the service |
Method | add |
Add a KEA plugin to the server |
Method | client |
set the client classes |
Method | hook |
Set the KEA plugins on this server |
Method | reservations |
set global reservations. If true, reservations are global, if false, they are not |
Method | reservations |
set reservations in subnet. If true, reservations are in subnet, if false, they are not |
Method | reservations |
set whether host reservations lookup should be performed before lease lookup |
Method | reservations |
set whether host reservations can be made outside the pool when reservations-in-subnet is true |
Method | update |
Send the service to the server |
Instance Variable | default |
A list of default nameservers for the DHCP service |
Instance Variable | dhcp |
The DHCP Queue Control Object for the DHCP service |
Instance Variable | early |
Whether to do an early global reservations lookup |
Instance Variable | expired |
The Expired Leases Processing object for the DHCP service |
Instance Variable | global |
A dictionary of global DHCP Options for the DHCP service |
Instance Variable | host |
A list of host reservation identifiers |
Instance Variable | hostname |
The hostname character replacement because using banned characters is like a sport for some people |
Instance Variable | hostname |
The hostname character set in case you want to put your foot down |
Instance Variable | interfaces |
The Interfaces Config object for the DHCP service |
Instance Variable | ip |
Whether IP reservations are unique |
Instance Variable | json |
Initialize a DHCP service object, with empty strings and lists |
Instance Variable | lease |
The Lease Database object for the DHCP service |
Instance Variable | loggers |
A list of Logger objects for the DHCP service |
Instance Variable | mac |
A list of MAC sources used by DHCP service |
Instance Variable | multi |
The Multi Threading object for the DHCP service, sets the threading options |
Instance Variable | option |
A list of DHCP options that define the option definitions used by option_data |
Instance Variable | relay |
A list of the DHCP Options supplied by the relay |
Instance Variable | sanity |
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 |
The Server ID object for the DHCP service |
Instance Variable | server |
The server tag for the DHCP service |
Instance Variable | statistic |
The default sample age for statistics |
Instance Variable | statistic |
The default sample count for statistics |
Instance Variable | store |
Whether to store extended lease info |
Instance Variable | subnet |
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 |
the client classes |
Property | hook |
The KEA plugins on this server |
Property | reservations |
fetch global reservations. If true, reservations are global, if false, they are not |
Property | reservations |
fetch reservations in subnet. If true, reservations are in subnet, if false, they are not |
Property | reservations |
controls whether host reservations lookup should be performed before lease lookup |
Property | reservations |
controls whether host reservations can be made outside the pool when reservations-in-subnet is true |
Instance Variable | _client |
Undocumented |
Instance Variable | _hook |
Undocumented |
Instance Variable | _reservations |
Undocumented |
Instance Variable | _reservations |
Undocumented |
Instance Variable | _reservations |
Undocumented |
Instance Variable | _reservations |
Undocumented |
Inherited from Allocator
(via DhcpService
):
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 | 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 |
overrides
dhcpy.dhcp_service.DhcpService.__init__
Initialize a DHCP4 service object, with empty strings and lists