-
dhcpy
index.html
Package
Package
PUBLIC
Tools for managing a KEA DHCP server.
-
dhcpy.ClientClass
dhcpy.ClientClass.html
Module
Module
PUBLIC
A class to represent a client class in KEA
-
dhcpy.Logger
dhcpy.Logger.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.allocator
dhcpy.allocator.html
Module
Module
PUBLIC
Base class for objects that allocate addresses.
-
dhcpy.allocatorType
dhcpy.allocatorType.html
Module
Module
PUBLIC
This module contains the AllocatorType enum for the Allocator classes.
-
dhcpy.dhcpOption
dhcpy.dhcpOption.html
Module
Module
PUBLIC
A module to represent a DHCP option definition or implementation
-
dhcpy.dhcpQueueControl
dhcpy.dhcpQueueControl.html
Module
Module
PUBLIC
This module contains the class DHCPQueueControl, which is used to store the configuration of the DHCP queue control.
-
dhcpy.dhcp_service
dhcpy.dhcp_service.html
Module
Module
PUBLIC
This module contains the classes for the DHCP service base class and the DHCP4 and DHCP6 implementations.
-
dhcpy.expiredLeaseProcessing
dhcpy.expiredLeaseProcessing.html
Module
Module
PUBLIC
Expired Lease Processing object for the DHCP service
-
dhcpy.hookLibrary
dhcpy.hookLibrary.html
Module
Module
PUBLIC
Plugins for KEA are called hooks, and this is a hacked version of the hookLibrary class for the dhcpy project.
-
dhcpy.interfacesConfig
dhcpy.interfacesConfig.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.leaseDatabase
dhcpy.leaseDatabase.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.multiThreading
dhcpy.multiThreading.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.pool
dhcpy.pool.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.sanityChecks
dhcpy.sanityChecks.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.sendToServer
dhcpy.sendToServer.html
Module
Module
PUBLIC
Fucntions for sending commands to KEA server
-
dhcpy.server
dhcpy.server.html
Module
Module
PUBLIC
An object to store server information, like IP address, hostname, and interfaces
-
dhcpy.serverID
dhcpy.serverID.html
Module
Module
PUBLIC
Undocumented
-
dhcpy.subnet
dhcpy.subnet.html
Module
Module
PUBLIC
KEA subnet pools
-
dhcpy.subnetType
dhcpy.subnetType.html
Module
Module
PUBLIC
This file contains the SubnetType enum. This is used to determine the type of subnet that KEA is handling. This is used to determine the type of pool to use and the commands to run on the server.
-
dhcpy.allocatorType.AllocatorType
dhcpy.allocatorType.AllocatorType.html
Class
Class
PUBLIC
Tells an allocator to give out IPs in a row (iterative) or randomly (randomized)
-
dhcpy.allocatorType.AllocatorType.none
dhcpy.allocatorType.AllocatorType.html#none
Attribute
Class Variable
PUBLIC
No allocator set
-
dhcpy.allocatorType.AllocatorType.iterative
dhcpy.allocatorType.AllocatorType.html#iterative
Attribute
Class Variable
PUBLIC
Gives out IPs in a row
-
dhcpy.allocatorType.AllocatorType.randomized
dhcpy.allocatorType.AllocatorType.html#randomized
Attribute
Class Variable
PUBLIC
Gives out IPs randomly
-
dhcpy.dhcpOption.OptionUsage
dhcpy.dhcpOption.OptionUsage.html
Class
Class
PUBLIC
An enum to represent the possible usages of a DHCP option
-
dhcpy.dhcpOption.OptionUsage.NONE
dhcpy.dhcpOption.OptionUsage.html#NONE
Attribute
Constant
PUBLIC
No usage was set
-
dhcpy.dhcpOption.OptionUsage.OPTION_DEFINITION
dhcpy.dhcpOption.OptionUsage.html#OPTION_DEFINITION
Attribute
Constant
PUBLIC
The option is defining an option (for option-def)
-
dhcpy.dhcpOption.OptionUsage.OPTION_IMPLEMENTATION
dhcpy.dhcpOption.OptionUsage.html#OPTION_IMPLEMENTATION
Attribute
Constant
PUBLIC
The option is implementing an option (for option-data)
-
dhcpy.dhcpOption.DHCPOption
dhcpy.dhcpOption.DHCPOption.html
Class
Class
PUBLIC
A class to represent a DHCP option
-
dhcpy.dhcpOption.DHCPOption.__init__
dhcpy.dhcpOption.DHCPOption.html#__init__
Function
Method
PUBLIC
Initialize a DHCP option :param space: The vendor space of the option :param name: The name of the option :param code: The type code of the option :param data: The data of the option :param always_send: A boolean to determine if the option should always be sent...
-
dhcpy.dhcpOption.DHCPOption.never_send_set
dhcpy.dhcpOption.DHCPOption.html#never_send_set
Attribute
Instance Variable
PUBLIC
Never send option was set
-
dhcpy.dhcpOption.DHCPOption.always_send_set
dhcpy.dhcpOption.DHCPOption.html#always_send_set
Attribute
Instance Variable
PUBLIC
Always send option was set
-
dhcpy.dhcpOption.DHCPOption.array_set
dhcpy.dhcpOption.DHCPOption.html#array_set
Attribute
Instance Variable
PUBLIC
Array option was set
-
dhcpy.dhcpOption.DHCPOption.csv_format_set
dhcpy.dhcpOption.DHCPOption.html#csv_format_set
Attribute
Instance Variable
PUBLIC
CSV format option was set
-
dhcpy.dhcpOption.DHCPOption.encapsulate_set
dhcpy.dhcpOption.DHCPOption.html#encapsulate_set
Attribute
Instance Variable
PUBLIC
encapsulate option was set
-
dhcpy.dhcpOption.DHCPOption.record_types_set
dhcpy.dhcpOption.DHCPOption.html#record_types_set
Attribute
Instance Variable
PUBLIC
record types option was set
-
dhcpy.dhcpOption.DHCPOption.option_usage
dhcpy.dhcpOption.DHCPOption.html#option_usage
Attribute
Instance Variable
PUBLIC
Is the option defining or implementing an option
-
dhcpy.dhcpOption.DHCPOption.__dict__
dhcpy.dhcpOption.DHCPOption.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the option, for making JSON in the format KEA expects
-
dhcpy.dhcpOption.DHCPOption.space 0
dhcpy.dhcpOption.DHCPOption.html#space%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.space
dhcpy.dhcpOption.DHCPOption.html#space
Attribute
Instance Variable
PUBLIC
Return the vendor space of the option
-
dhcpy.dhcpOption.DHCPOption.name 0
dhcpy.dhcpOption.DHCPOption.html#name%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.name
dhcpy.dhcpOption.DHCPOption.html#name
Attribute
Instance Variable
PUBLIC
Return the name of the option
-
dhcpy.dhcpOption.DHCPOption.code 0
dhcpy.dhcpOption.DHCPOption.html#code%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.code
dhcpy.dhcpOption.DHCPOption.html#code
Attribute
Instance Variable
PUBLIC
Return the code of the option
-
dhcpy.dhcpOption.DHCPOption.data 0
dhcpy.dhcpOption.DHCPOption.html#data%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.data
dhcpy.dhcpOption.DHCPOption.html#data
Attribute
Instance Variable
PUBLIC
Return the data of the option
-
dhcpy.dhcpOption.DHCPOption.always_send 0
dhcpy.dhcpOption.DHCPOption.html#always_send%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.always_send
dhcpy.dhcpOption.DHCPOption.html#always_send
Attribute
Instance Variable
PUBLIC
Return a boolean to determine if the option should always be sent
-
dhcpy.dhcpOption.DHCPOption.never_send 0
dhcpy.dhcpOption.DHCPOption.html#never_send%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.never_send
dhcpy.dhcpOption.DHCPOption.html#never_send
Attribute
Instance Variable
PUBLIC
Return a boolean to determine if the option should always be sent
-
dhcpy.dhcpOption.DHCPOption.array 0
dhcpy.dhcpOption.DHCPOption.html#array%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.array
dhcpy.dhcpOption.DHCPOption.html#array
Attribute
Instance Variable
PUBLIC
Return a boolean to determine if the option is an array
-
dhcpy.dhcpOption.DHCPOption.type 0
dhcpy.dhcpOption.DHCPOption.html#type%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.type
dhcpy.dhcpOption.DHCPOption.html#type
Attribute
Instance Variable
PUBLIC
Return the data type
-
dhcpy.dhcpOption.DHCPOption.csv_format 0
dhcpy.dhcpOption.DHCPOption.html#csv_format%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.csv_format
dhcpy.dhcpOption.DHCPOption.html#csv_format
Attribute
Instance Variable
PUBLIC
Return the csv_format
-
dhcpy.dhcpOption.DHCPOption.encapsulate 0
dhcpy.dhcpOption.DHCPOption.html#encapsulate%200
Attribute
Instance Variable
PUBLIC
the string that the encapsulated options use to identify this option
-
dhcpy.dhcpOption.DHCPOption.encapsulate
dhcpy.dhcpOption.DHCPOption.html#encapsulate
Attribute
Instance Variable
PUBLIC
Return the encapsulated name
-
dhcpy.dhcpOption.DHCPOption.record_types 0
dhcpy.dhcpOption.DHCPOption.html#record_types%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpOption.DHCPOption.record_types
dhcpy.dhcpOption.DHCPOption.html#record_types
Attribute
Instance Variable
PUBLIC
Return the record_types
-
dhcpy.dhcpOption.DHCPOption.always_send_string
dhcpy.dhcpOption.DHCPOption.html#always_send_string
Function
Method
PUBLIC
Return always_send as a string, all lowercase, for the JSON output
-
dhcpy.dhcpOption.DHCPOption.array_string
dhcpy.dhcpOption.DHCPOption.html#array_string
Function
Method
PUBLIC
Return array as a string, all lowercase, for the JSON output
-
dhcpy.dhcpOption.DHCPOption.space.setter
dhcpy.dhcpOption.DHCPOption.html#space.setter
Function
Method
PUBLIC
Set the vendor space of the option
-
dhcpy.dhcpOption.DHCPOption._space
dhcpy.dhcpOption.DHCPOption.html#_space
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.name.setter
dhcpy.dhcpOption.DHCPOption.html#name.setter
Function
Method
PUBLIC
Set the name of the option
-
dhcpy.dhcpOption.DHCPOption._name
dhcpy.dhcpOption.DHCPOption.html#_name
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.code.setter
dhcpy.dhcpOption.DHCPOption.html#code.setter
Function
Method
PUBLIC
Set the code of the option
-
dhcpy.dhcpOption.DHCPOption._code
dhcpy.dhcpOption.DHCPOption.html#_code
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.data.setter
dhcpy.dhcpOption.DHCPOption.html#data.setter
Function
Method
PUBLIC
Set the data of the option
-
dhcpy.dhcpOption.DHCPOption._data
dhcpy.dhcpOption.DHCPOption.html#_data
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.always_send.setter
dhcpy.dhcpOption.DHCPOption.html#always_send.setter
Function
Method
PUBLIC
Set a boolean to determine if the option should always be sent
-
dhcpy.dhcpOption.DHCPOption._always_send
dhcpy.dhcpOption.DHCPOption.html#_always_send
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.never_send.setter
dhcpy.dhcpOption.DHCPOption.html#never_send.setter
Function
Method
PUBLIC
Set a boolean to determine if the option should never be sent
-
dhcpy.dhcpOption.DHCPOption._never_send
dhcpy.dhcpOption.DHCPOption.html#_never_send
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.array.setter
dhcpy.dhcpOption.DHCPOption.html#array.setter
Function
Method
PUBLIC
Value of the option is an array
-
dhcpy.dhcpOption.DHCPOption._array
dhcpy.dhcpOption.DHCPOption.html#_array
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption._array_set
dhcpy.dhcpOption.DHCPOption.html#_array_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.type.setter
dhcpy.dhcpOption.DHCPOption.html#type.setter
Function
Method
PUBLIC
Set the name of the option
-
dhcpy.dhcpOption.DHCPOption._type
dhcpy.dhcpOption.DHCPOption.html#_type
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.csv_format.setter
dhcpy.dhcpOption.DHCPOption.html#csv_format.setter
Function
Method
PUBLIC
Set the csv_format
-
dhcpy.dhcpOption.DHCPOption._csv_format
dhcpy.dhcpOption.DHCPOption.html#_csv_format
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption._csv_format_set
dhcpy.dhcpOption.DHCPOption.html#_csv_format_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.encapsulate.setter
dhcpy.dhcpOption.DHCPOption.html#encapsulate.setter
Function
Method
PUBLIC
Set the encapsulated name
-
dhcpy.dhcpOption.DHCPOption._encapsulate
dhcpy.dhcpOption.DHCPOption.html#_encapsulate
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption._encapsulate_set
dhcpy.dhcpOption.DHCPOption.html#_encapsulate_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.record_types.setter
dhcpy.dhcpOption.DHCPOption.html#record_types.setter
Function
Method
PUBLIC
Set the record_types
-
dhcpy.dhcpOption.DHCPOption._record_types
dhcpy.dhcpOption.DHCPOption.html#_record_types
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption._record_types_set
dhcpy.dhcpOption.DHCPOption.html#_record_types_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpOption.DHCPOption.fill_from_json
dhcpy.dhcpOption.DHCPOption.html#fill_from_json
Function
Method
PUBLIC
:param json_str: :return:
-
dhcpy.allocator.Allocator
dhcpy.allocator.Allocator.html
Class
Class
PUBLIC
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...
-
dhcpy.allocator.Allocator.__init__
dhcpy.allocator.Allocator.html#__init__
Function
Method
PUBLIC
Initialize the object
-
dhcpy.allocator.Allocator.sets_allocator_type
dhcpy.allocator.Allocator.html#sets_allocator_type
Attribute
Instance Variable
PUBLIC
Flag to indicate if the allocator type has been set
-
dhcpy.allocator.Allocator.sets_tee_times
dhcpy.allocator.Allocator.html#sets_tee_times
Attribute
Instance Variable
PUBLIC
Flag to indicate if tee times have been set
-
dhcpy.allocator.Allocator.sets_valid_lifetime
dhcpy.allocator.Allocator.html#sets_valid_lifetime
Attribute
Instance Variable
PUBLIC
Flag to indicate if the valid lifetime has been set
-
dhcpy.allocator.Allocator.sets_renew_timer
dhcpy.allocator.Allocator.html#sets_renew_timer
Attribute
Instance Variable
PUBLIC
Flag to indicate if the renew timer has been set
-
dhcpy.allocator.Allocator.sets_rebind_timer
dhcpy.allocator.Allocator.html#sets_rebind_timer
Attribute
Instance Variable
PUBLIC
Flag to indicate if the rebind timer has been set
-
dhcpy.allocator.Allocator.sets_preferred_lifetime
dhcpy.allocator.Allocator.html#sets_preferred_lifetime
Attribute
Instance Variable
PUBLIC
Flag to indicate if the preferred lifetime has been set
-
dhcpy.allocator.Allocator.sets_decline_probation_period
dhcpy.allocator.Allocator.html#sets_decline_probation_period
Attribute
Instance Variable
PUBLIC
Flag to indicate if the probation period for declined leases has been set
-
dhcpy.allocator.Allocator.sets_t1_percent
dhcpy.allocator.Allocator.html#sets_t1_percent
Attribute
Instance Variable
PUBLIC
Flag to indicate if the T1 percent has been set
-
dhcpy.allocator.Allocator.sets_t2_percent
dhcpy.allocator.Allocator.html#sets_t2_percent
Attribute
Instance Variable
PUBLIC
Flag to indicate if the T2 percent has been set
-
dhcpy.allocator.Allocator.allocator_type 0
dhcpy.allocator.Allocator.html#allocator_type%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.allocator_type
dhcpy.allocator.Allocator.html#allocator_type
Attribute
Instance Variable
PUBLIC
itterative or randomized. Assign using an AllocatorType enum or string, the object figures it out.
-
dhcpy.allocator.Allocator.allocator_type.setter
dhcpy.allocator.Allocator.html#allocator_type.setter
Function
Method
PUBLIC
Set the allocator type, making sure it's either an AllocatorType enum or a string that matches one of the AllocatorType values
-
dhcpy.allocator.Allocator._allocator_type
dhcpy.allocator.Allocator.html#_allocator_type
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.calculate_tee_times 0
dhcpy.allocator.Allocator.html#calculate_tee_times%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.calculate_tee_times
dhcpy.allocator.Allocator.html#calculate_tee_times
Attribute
Instance Variable
PUBLIC
Calculate tee times. Default is True
-
dhcpy.allocator.Allocator.calculate_tee_times.setter
dhcpy.allocator.Allocator.html#calculate_tee_times.setter
Function
Method
PUBLIC
Set the calculate tee times flag :param calculate_tee_times: A boolean to determine if tee times should be calculated
-
dhcpy.allocator.Allocator._calculate_tee_times
dhcpy.allocator.Allocator.html#_calculate_tee_times
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.valid_lifetime 0
dhcpy.allocator.Allocator.html#valid_lifetime%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.valid_lifetime
dhcpy.allocator.Allocator.html#valid_lifetime
Attribute
Instance Variable
PUBLIC
The valid lifetime of the lease. Default is 0
-
dhcpy.allocator.Allocator.valid_lifetime.setter
dhcpy.allocator.Allocator.html#valid_lifetime.setter
Function
Method
PUBLIC
Set the valid lifetime of the lease :param valid_lifetime: The valid lifetime of the lease in seconds
-
dhcpy.allocator.Allocator._valid_lifetime
dhcpy.allocator.Allocator.html#_valid_lifetime
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.renew_timer 0
dhcpy.allocator.Allocator.html#renew_timer%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.renew_timer
dhcpy.allocator.Allocator.html#renew_timer
Attribute
Instance Variable
PUBLIC
The renew timer. Default is 0
-
dhcpy.allocator.Allocator.renew_timer.setter
dhcpy.allocator.Allocator.html#renew_timer.setter
Function
Method
PUBLIC
Set the renew timer :param renew_timer: The renew timer in seconds
-
dhcpy.allocator.Allocator._renew_timer
dhcpy.allocator.Allocator.html#_renew_timer
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.rebind_timer 0
dhcpy.allocator.Allocator.html#rebind_timer%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.rebind_timer
dhcpy.allocator.Allocator.html#rebind_timer
Attribute
Instance Variable
PUBLIC
The rebind timer. Default is 0
-
dhcpy.allocator.Allocator.rebind_timer.setter
dhcpy.allocator.Allocator.html#rebind_timer.setter
Function
Method
PUBLIC
Set the rebind timer :param rebind_timer: The rebind timer in seconds
-
dhcpy.allocator.Allocator._rebind_timer
dhcpy.allocator.Allocator.html#_rebind_timer
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.preferred_lifetime 0
dhcpy.allocator.Allocator.html#preferred_lifetime%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.preferred_lifetime
dhcpy.allocator.Allocator.html#preferred_lifetime
Attribute
Instance Variable
PUBLIC
The preferred lifetime of the lease. Default is 0
-
dhcpy.allocator.Allocator.preferred_lifetime.setter
dhcpy.allocator.Allocator.html#preferred_lifetime.setter
Function
Method
PUBLIC
Set the preferred lifetime of the lease :param preferred_lifetime: The preferred lifetime of the lease in seconds
-
dhcpy.allocator.Allocator._preferred_lifetime
dhcpy.allocator.Allocator.html#_preferred_lifetime
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.decline_probation_period 0
dhcpy.allocator.Allocator.html#decline_probation_period%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.decline_probation_period
dhcpy.allocator.Allocator.html#decline_probation_period
Attribute
Instance Variable
PUBLIC
The probation period for declined leases. Default is 0
-
dhcpy.allocator.Allocator.decline_probation_period.setter
dhcpy.allocator.Allocator.html#decline_probation_period.setter
Function
Method
PUBLIC
Set the probation period for declined leases :param decline_probation_period: The probation period in seconds
-
dhcpy.allocator.Allocator._decline_probation_period
dhcpy.allocator.Allocator.html#_decline_probation_period
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.option_data 0
dhcpy.allocator.Allocator.html#option_data%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.option_data
dhcpy.allocator.Allocator.html#option_data
Attribute
Instance Variable
PUBLIC
A list of DHCP options to be sent with the lease. These contain the settings for the lease
-
dhcpy.allocator.Allocator.option_data.setter
dhcpy.allocator.Allocator.html#option_data.setter
Function
Method
PUBLIC
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
-
dhcpy.allocator.Allocator._option_data
dhcpy.allocator.Allocator.html#_option_data
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.add_option_data
dhcpy.allocator.Allocator.html#add_option_data
Function
Method
PUBLIC
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
-
dhcpy.allocator.Allocator.option_defs 0
dhcpy.allocator.Allocator.html#option_defs%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.option_defs
dhcpy.allocator.Allocator.html#option_defs
Attribute
Instance Variable
PUBLIC
A list of DHCP options that define the option definitions used by option_data
-
dhcpy.allocator.Allocator.option_defs.setter
dhcpy.allocator.Allocator.html#option_defs.setter
Function
Method
PUBLIC
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
-
dhcpy.allocator.Allocator._option_defs
dhcpy.allocator.Allocator.html#_option_defs
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.add_option_def
dhcpy.allocator.Allocator.html#add_option_def
Function
Method
PUBLIC
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
-
dhcpy.allocator.Allocator.parked_packet_limit 0
dhcpy.allocator.Allocator.html#parked_packet_limit%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.parked_packet_limit
dhcpy.allocator.Allocator.html#parked_packet_limit
Attribute
Property
PUBLIC
The max number of packets that can be parked. Default is 0
-
dhcpy.allocator.Allocator.parked_packet_limit.setter
dhcpy.allocator.Allocator.html#parked_packet_limit.setter
Function
Method
PUBLIC
Set the parked packet limit :param parked_packet_limit: The max number of packets that can be parked
-
dhcpy.allocator.Allocator._parked_packet_limit
dhcpy.allocator.Allocator.html#_parked_packet_limit
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.t1_percent 0
dhcpy.allocator.Allocator.html#t1_percent%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.t1_percent
dhcpy.allocator.Allocator.html#t1_percent
Attribute
Instance Variable
PUBLIC
T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1
-
dhcpy.allocator.Allocator.t1_percent.setter
dhcpy.allocator.Allocator.html#t1_percent.setter
Function
Method
PUBLIC
Set the T1 percent :param t1_percent: The T1 percent. Should be between 0 and 1
-
dhcpy.allocator.Allocator._t1_percent
dhcpy.allocator.Allocator.html#_t1_percent
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.t2_percent 0
dhcpy.allocator.Allocator.html#t2_percent%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.allocator.Allocator.t2_percent
dhcpy.allocator.Allocator.html#t2_percent
Attribute
Instance Variable
PUBLIC
T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1
-
dhcpy.allocator.Allocator.t2_percent.setter
dhcpy.allocator.Allocator.html#t2_percent.setter
Function
Method
PUBLIC
Set the T2 percent :param t2_percent: The T2 percent. Should be between 0 and 1
-
dhcpy.allocator.Allocator._t2_percent
dhcpy.allocator.Allocator.html#_t2_percent
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.allocator.Allocator.__dict__
dhcpy.allocator.Allocator.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the object, for making JSON in the format KEA expects
-
dhcpy.allocator.Allocator.fill_from_json
dhcpy.allocator.Allocator.html#fill_from_json
Function
Method
PUBLIC
Fill the object from the JSON dictionary from the KEA web interface :param json_data: The JSON dictionary to fill the object from
-
dhcpy.ClientClass.ClientClass
dhcpy.ClientClass.ClientClass.html
Class
Class
PUBLIC
A class to represent a client class
-
dhcpy.ClientClass.ClientClass.__init__
dhcpy.ClientClass.ClientClass.html#__init__
Function
Method
PUBLIC
Initialize a client class :param name: The name of the client class :param test: The test for when to apply the client class :param option_data: A list of option data
-
dhcpy.ClientClass.ClientClass._test
dhcpy.ClientClass.ClientClass.html#_test
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.ClientClass.ClientClass.__dict__
dhcpy.ClientClass.ClientClass.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the client class, for making json for kea
-
dhcpy.ClientClass.ClientClass.name 0
dhcpy.ClientClass.ClientClass.html#name%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.ClientClass.ClientClass.name
dhcpy.ClientClass.ClientClass.html#name
Attribute
Instance Variable
PUBLIC
Return the name of the client class
-
dhcpy.ClientClass.ClientClass.test
dhcpy.ClientClass.ClientClass.html#test
Attribute
Instance Variable
PUBLIC
Return the test of the client class
-
dhcpy.ClientClass.ClientClass.name.setter
dhcpy.ClientClass.ClientClass.html#name.setter
Function
Method
PUBLIC
Set the name of the client class
-
dhcpy.ClientClass.ClientClass._name
dhcpy.ClientClass.ClientClass.html#_name
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.ClientClass.ClientClass.test.setter
dhcpy.ClientClass.ClientClass.html#test.setter
Function
Method
PUBLIC
Set the test of the client class
-
dhcpy.ClientClass.ClientClass.add_option_data
dhcpy.ClientClass.ClientClass.html#add_option_data
Function
Method
PUBLIC
Add an option data to the client class
-
dhcpy.ClientClass.ClientClass.fill_from_json
dhcpy.ClientClass.ClientClass.html#fill_from_json
Function
Method
PUBLIC
Fill the client class from a json string
-
dhcpy.subnetType.SubnetType
dhcpy.subnetType.SubnetType.html
Class
Class
PUBLIC
Different types of subnets that KEA can handle. This is used to determine the type of pool to use and the commands to run on the server.
-
dhcpy.subnetType.SubnetType.none
dhcpy.subnetType.SubnetType.html#none
Attribute
Class Variable
PUBLIC
No subnet type set
-
dhcpy.subnetType.SubnetType.v4
dhcpy.subnetType.SubnetType.html#v4
Attribute
Class Variable
PUBLIC
IPv4 subnet
-
dhcpy.subnetType.SubnetType.v6
dhcpy.subnetType.SubnetType.html#v6
Attribute
Class Variable
PUBLIC
IPv6 NA subnet
-
dhcpy.subnetType.SubnetType.pd
dhcpy.subnetType.SubnetType.html#pd
Attribute
Class Variable
PUBLIC
IPv6 PD subnet
-
dhcpy.pool.Pool
dhcpy.pool.Pool.html
Class
Class
PUBLIC
No class docstring; 1/3 instance variable, 5/5 methods documented
-
dhcpy.pool.Pool.__init__
dhcpy.pool.Pool.html#__init__
Function
Method
PUBLIC
Initialize a pool object (just the IP range for a rule) :param ip_range: A string in the format "Start-End"
-
dhcpy.pool.Pool.__dict__
dhcpy.pool.Pool.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the pool, for making JSON in the format KEA expects
-
dhcpy.pool.Pool.ip_range 0
dhcpy.pool.Pool.html#ip_range%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.pool.Pool.ip_range
dhcpy.pool.Pool.html#ip_range
Attribute
Instance Variable
PUBLIC
Return the IP range as a string in the format "Start-End"
-
dhcpy.pool.Pool.ip_range.setter
dhcpy.pool.Pool.html#ip_range.setter
Function
Method
PUBLIC
Set the IP range from a string in the format "Start-End"
-
dhcpy.pool.Pool.subnet_type
dhcpy.pool.Pool.html#subnet_type
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.pool.Pool._ip_range
dhcpy.pool.Pool.html#_ip_range
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.pool.Pool.ip_range.deleter
dhcpy.pool.Pool.html#ip_range.deleter
Function
Method
PUBLIC
Delete the IP range. Don't do this, because it doesn't do anything.
-
dhcpy.pool.Pool.fill_from_json
dhcpy.pool.Pool.html#fill_from_json
Function
Method
PUBLIC
Decode a JSON string into a pool object
-
dhcpy.subnet.Subnet
dhcpy.subnet.Subnet.html
Class
Class
PUBLIC
A class to represent a subnet in KEA, containing pools of addresses, DHCP options, and other settings
-
dhcpy.subnet.Subnet.__init__
dhcpy.subnet.Subnet.html#__init__
Function
Method
PUBLIC
Initialize a subnet object, with empty strings and lists
-
dhcpy.subnet.Subnet.subnet_type
dhcpy.subnet.Subnet.html#subnet_type
Attribute
Instance Variable
PUBLIC
The type of subnet, subnet_type.v4, subnet_type.v6, or subnet_type.pd
-
dhcpy.subnet.Subnet.pools
dhcpy.subnet.Subnet.html#pools
Attribute
Instance Variable
PUBLIC
A list of Pool objects
-
dhcpy.subnet.Subnet.name
dhcpy.subnet.Subnet.html#name
Attribute
Instance Variable
PUBLIC
The name of the subnet
-
dhcpy.subnet.Subnet.id
dhcpy.subnet.Subnet.html#id
Attribute
Instance Variable
PUBLIC
The ID of the subnet. This must be unique on the server, but the only test so far is that it is not negative
-
dhcpy.subnet.Subnet.client_class_set
dhcpy.subnet.Subnet.html#client_class_set
Attribute
Instance Variable
PUBLIC
A client class for the subnet. Mostly a placeholder at this time
-
dhcpy.subnet.Subnet.pd_allocator
dhcpy.subnet.Subnet.html#pd_allocator
Attribute
Instance Variable
PUBLIC
The allocator for the subnet. Like, do the addresses all in a row, or randomize it
-
dhcpy.subnet.Subnet.calculate_tee_times
dhcpy.subnet.Subnet.html#calculate_tee_times
Attribute
Instance Variable
PUBLIC
Calculate tee times. Default is True
-
dhcpy.subnet.Subnet.interface
dhcpy.subnet.Subnet.html#interface
Attribute
Instance Variable
PUBLIC
The interface that can allocate addresses from this subnet
-
dhcpy.subnet.Subnet.max_preferred_lifetime
dhcpy.subnet.Subnet.html#max_preferred_lifetime
Attribute
Instance Variable
PUBLIC
The maximum preferred lifetime for an address in this subnet
-
dhcpy.subnet.Subnet.max_valid_lifetime
dhcpy.subnet.Subnet.html#max_valid_lifetime
Attribute
Instance Variable
PUBLIC
The maximum valid lifetime for an address in this subnet
-
dhcpy.subnet.Subnet.min_valid_lifetime
dhcpy.subnet.Subnet.html#min_valid_lifetime
Attribute
Instance Variable
PUBLIC
The minimum valid lifetime for an address in this subnet
-
dhcpy.subnet.Subnet.valid_lifetime
dhcpy.subnet.Subnet.html#valid_lifetime
Attribute
Instance Variable
PUBLIC
The valid lifetime of the lease. Default is 0
-
dhcpy.subnet.Subnet.min_preferred_lifetime
dhcpy.subnet.Subnet.html#min_preferred_lifetime
Attribute
Instance Variable
PUBLIC
The minimum preferred lifetime for an lease in this subnet
-
dhcpy.subnet.Subnet.preferred_lifetime
dhcpy.subnet.Subnet.html#preferred_lifetime
Attribute
Instance Variable
PUBLIC
The preferred lifetime of the lease. Default is 0
-
dhcpy.subnet.Subnet._rapid_commit
dhcpy.subnet.Subnet.html#_rapid_commit
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._rapid_commit_set
dhcpy.subnet.Subnet.html#_rapid_commit_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet.t1_percent
dhcpy.subnet.Subnet.html#t1_percent
Attribute
Instance Variable
PUBLIC
T1 is when renewal should be attempted. Default is 0.5. Should be between 0 and 1
-
dhcpy.subnet.Subnet.t2_percent
dhcpy.subnet.Subnet.html#t2_percent
Attribute
Instance Variable
PUBLIC
T2 is when rebind should be attempted. Default is 0.8. Should be between 0 and 1
-
dhcpy.subnet.Subnet.store_extended_info
dhcpy.subnet.Subnet.html#store_extended_info
Attribute
Instance Variable
PUBLIC
Store extended info about the leases in this subnet
-
dhcpy.subnet.Subnet._renew_timer
dhcpy.subnet.Subnet.html#_renew_timer
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._renew_timer_set
dhcpy.subnet.Subnet.html#_renew_timer_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._rebind_timer
dhcpy.subnet.Subnet.html#_rebind_timer
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._rebind_timer_set
dhcpy.subnet.Subnet.html#_rebind_timer_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._relays
dhcpy.subnet.Subnet.html#_relays
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._relays_set
dhcpy.subnet.Subnet.html#_relays_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet.client_class 0
dhcpy.subnet.Subnet.html#client_class%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.subnet.Subnet.client_class
dhcpy.subnet.Subnet.html#client_class
Attribute
Instance Variable
PUBLIC
Return the client class
-
dhcpy.subnet.Subnet.client_class.setter
dhcpy.subnet.Subnet.html#client_class.setter
Function
Method
PUBLIC
Set the client class
-
dhcpy.subnet.Subnet._client_class_name
dhcpy.subnet.Subnet.html#_client_class_name
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet._client_class_set
dhcpy.subnet.Subnet.html#_client_class_set
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.subnet.Subnet.relays
dhcpy.subnet.Subnet.html#relays
Attribute
Property
PUBLIC
Return the relays
-
dhcpy.subnet.Subnet.relays.setter
dhcpy.subnet.Subnet.html#relays.setter
Function
Method
PUBLIC
Set the relays
-
dhcpy.subnet.Subnet.add_relay
dhcpy.subnet.Subnet.html#add_relay
Function
Method
PUBLIC
Add a relay to the list of relays
-
dhcpy.subnet.Subnet.renew_timer
dhcpy.subnet.Subnet.html#renew_timer
Attribute
Instance Variable
PUBLIC
Return the renew timer
-
dhcpy.subnet.Subnet.renew_timer.setter
dhcpy.subnet.Subnet.html#renew_timer.setter
Function
Method
PUBLIC
Set the renew timer
-
dhcpy.subnet.Subnet.rebind_timer
dhcpy.subnet.Subnet.html#rebind_timer
Attribute
Instance Variable
PUBLIC
Return the renew timer
-
dhcpy.subnet.Subnet.rebind_timer.setter
dhcpy.subnet.Subnet.html#rebind_timer.setter
Function
Method
PUBLIC
Set the renew timer
-
dhcpy.subnet.Subnet.rapid_commit
dhcpy.subnet.Subnet.html#rapid_commit
Attribute
Instance Variable
PUBLIC
Return the rapid commit setting
-
dhcpy.subnet.Subnet.rapid_commit.setter
dhcpy.subnet.Subnet.html#rapid_commit.setter
Function
Method
PUBLIC
Set the rapid commit setting
-
dhcpy.subnet.Subnet.__dict__
dhcpy.subnet.Subnet.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the subnet, for making JSON in the format KEA expects
-
dhcpy.subnet.Subnet.fill_from_json
dhcpy.subnet.Subnet.html#fill_from_json
Function
Method
PUBLIC
Decode a JSON object into a subnet object
-
dhcpy.sendToServer.KEA_PORT
dhcpy.sendToServer.html#KEA_PORT
Attribute
Constant
PUBLIC
Undocumented
-
dhcpy.sendToServer.send_subnet_to_server
dhcpy.sendToServer.html#send_subnet_to_server
Function
Function
PUBLIC
Send a subnet to a KEA server :param server: a server object with a management IP address and a list of interfaces :param subnet: a subnet object :return: No idea yet. But it should definitely return something...
-
dhcpy.sendToServer.get_config
dhcpy.sendToServer.html#get_config
Function
Function
PUBLIC
Get the configuration of a server :param server: a server object :return: a dictionary of the server configuration
-
dhcpy.sendToServer.get_v6_config
dhcpy.sendToServer.html#get_v6_config
Function
Function
PUBLIC
Get the configuration of a server :param server: a server object :return: a dictionary of the server configuration
-
dhcpy.sendToServer.get_v4_config
dhcpy.sendToServer.html#get_v4_config
Function
Function
PUBLIC
Get the configuration of a server :param server: a server object :return: a dictionary of the server configuration
-
dhcpy.sendToServer.save_config
dhcpy.sendToServer.html#save_config
Function
Function
PUBLIC
Get the configuration of a server :param server: a server object :return: a dictionary of the server configuration
-
dhcpy.dhcpQueueControl.DHCPQueueControl
dhcpy.dhcpQueueControl.DHCPQueueControl.html
Class
Class
PUBLIC
A class to represent the DHCP queue control in KEA
-
dhcpy.dhcpQueueControl.DHCPQueueControl.__init__
dhcpy.dhcpQueueControl.DHCPQueueControl.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.queue_type
dhcpy.dhcpQueueControl.DHCPQueueControl.html#queue_type
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.capacity 0
dhcpy.dhcpQueueControl.DHCPQueueControl.html#capacity%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.capacity
dhcpy.dhcpQueueControl.DHCPQueueControl.html#capacity
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.capacity.setter
dhcpy.dhcpQueueControl.DHCPQueueControl.html#capacity.setter
Function
Method
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl._capacity
dhcpy.dhcpQueueControl.DHCPQueueControl.html#_capacity
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.enable_queue 0
dhcpy.dhcpQueueControl.DHCPQueueControl.html#enable_queue%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.enable_queue
dhcpy.dhcpQueueControl.DHCPQueueControl.html#enable_queue
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.enable_queue.setter
dhcpy.dhcpQueueControl.DHCPQueueControl.html#enable_queue.setter
Function
Method
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl._enable_queue
dhcpy.dhcpQueueControl.DHCPQueueControl.html#_enable_queue
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.__dict__
dhcpy.dhcpQueueControl.DHCPQueueControl.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.dhcpQueueControl.DHCPQueueControl.fill_from_json
dhcpy.dhcpQueueControl.DHCPQueueControl.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html
Class
Class
PUBLIC
The Expired Leases Processing object for the DHCP service Tells KEA how to process expired leases
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.__init__
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#__init__
Function
Method
PUBLIC
Initialize the Expired Leases Processing object
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.flush_reclaimed_timer_wait_time
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#flush_reclaimed_timer_wait_time
Attribute
Instance Variable
PUBLIC
Seconds to wait after flushing reclaimed leases and restating the flush
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.hold_reclaimed_time
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#hold_reclaimed_time
Attribute
Instance Variable
PUBLIC
how long the lease should be kept after it is reclaimed
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.max_reclaim_leases
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#max_reclaim_leases
Attribute
Instance Variable
PUBLIC
the maximum number of reclaimed leases that can be processed at one time
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.max_reclaim_time
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#max_reclaim_time
Attribute
Instance Variable
PUBLIC
the maximum time that can be spent reclaiming leases
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.reclaim_timer_wait_time
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#reclaim_timer_wait_time
Attribute
Instance Variable
PUBLIC
how often the server starts the lease reclamation procedure
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.unwarned_reclaim_cycles
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#unwarned_reclaim_cycles
Attribute
Instance Variable
PUBLIC
how many consecutive clean-up cycles can end with remaining leases to be processed before a warning is printed
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.__dict__
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#__dict__
Function
Method
PUBLIC
return a dictionary representation of the Expired Leases Processing object, for making the KEA JSON thing
-
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.fill_from_json
dhcpy.expiredLeaseProcessing.ExpiredLeasesProcessing.html#fill_from_json
Function
Method
PUBLIC
Fill from the JSON from the KEA web API
-
dhcpy.interfacesConfig.InterfacesConfig
dhcpy.interfacesConfig.InterfacesConfig.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.__init__
dhcpy.interfacesConfig.InterfacesConfig.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.interfaces
dhcpy.interfacesConfig.InterfacesConfig.html#interfaces
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.re_detect_set
dhcpy.interfacesConfig.InterfacesConfig.html#re_detect_set
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.service_sockets_require_all
dhcpy.interfacesConfig.InterfacesConfig.html#service_sockets_require_all
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.re_detect 0
dhcpy.interfacesConfig.InterfacesConfig.html#re_detect%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.re_detect
dhcpy.interfacesConfig.InterfacesConfig.html#re_detect
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.re_detect.setter
dhcpy.interfacesConfig.InterfacesConfig.html#re_detect.setter
Function
Method
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig._re_detect
dhcpy.interfacesConfig.InterfacesConfig.html#_re_detect
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.__dict__
dhcpy.interfacesConfig.InterfacesConfig.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.interfacesConfig.InterfacesConfig.fill_from_json
dhcpy.interfacesConfig.InterfacesConfig.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase
dhcpy.leaseDatabase.LeaseDatabase.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase.__init__
dhcpy.leaseDatabase.LeaseDatabase.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase.name
dhcpy.leaseDatabase.LeaseDatabase.html#name
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase.persist
dhcpy.leaseDatabase.LeaseDatabase.html#persist
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase.type
dhcpy.leaseDatabase.LeaseDatabase.html#type
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase.__dict__
dhcpy.leaseDatabase.LeaseDatabase.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.leaseDatabase.LeaseDatabase.fill_from_json
dhcpy.leaseDatabase.LeaseDatabase.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.Logger.Logger
dhcpy.Logger.Logger.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.__init__
dhcpy.Logger.Logger.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.debuglevel
dhcpy.Logger.Logger.html#debuglevel
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.name
dhcpy.Logger.Logger.html#name
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.output_options
dhcpy.Logger.Logger.html#output_options
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.severity
dhcpy.Logger.Logger.html#severity
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.__dict__
dhcpy.Logger.Logger.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.Logger.Logger.fill_from_json
dhcpy.Logger.Logger.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading
dhcpy.multiThreading.MultiThreading.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading.__init__
dhcpy.multiThreading.MultiThreading.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading.enable_multithreading
dhcpy.multiThreading.MultiThreading.html#enable_multithreading
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading.packet_queue_size
dhcpy.multiThreading.MultiThreading.html#packet_queue_size
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading.thread_pool_size
dhcpy.multiThreading.MultiThreading.html#thread_pool_size
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading.__dict__
dhcpy.multiThreading.MultiThreading.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.multiThreading.MultiThreading.fill_from_json
dhcpy.multiThreading.MultiThreading.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.sanityChecks.SanityChecks
dhcpy.sanityChecks.SanityChecks.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.sanityChecks.SanityChecks.__init__
dhcpy.sanityChecks.SanityChecks.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.sanityChecks.SanityChecks.extended_info_checks
dhcpy.sanityChecks.SanityChecks.html#extended_info_checks
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.sanityChecks.SanityChecks.lease_checks
dhcpy.sanityChecks.SanityChecks.html#lease_checks
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.sanityChecks.SanityChecks.__dict__
dhcpy.sanityChecks.SanityChecks.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.sanityChecks.SanityChecks.fill_from_json
dhcpy.sanityChecks.SanityChecks.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID
dhcpy.serverID.ServerID.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.__init__
dhcpy.serverID.ServerID.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.enterprise_id
dhcpy.serverID.ServerID.html#enterprise_id
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.htype
dhcpy.serverID.ServerID.html#htype
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.identifier
dhcpy.serverID.ServerID.html#identifier
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.persist
dhcpy.serverID.ServerID.html#persist
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.time
dhcpy.serverID.ServerID.html#time
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.type
dhcpy.serverID.ServerID.html#type
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.__dict__
dhcpy.serverID.ServerID.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.serverID.ServerID.fill_from_json
dhcpy.serverID.ServerID.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.hookLibrary.HookLibrary
dhcpy.hookLibrary.HookLibrary.html
Class
Class
PUBLIC
Undocumented
-
dhcpy.hookLibrary.HookLibrary.__init__
dhcpy.hookLibrary.HookLibrary.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.hookLibrary.HookLibrary.library
dhcpy.hookLibrary.HookLibrary.html#library
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.hookLibrary.HookLibrary.parameters
dhcpy.hookLibrary.HookLibrary.html#parameters
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.hookLibrary.HookLibrary.__dict__
dhcpy.hookLibrary.HookLibrary.html#__dict__
Function
Method
PUBLIC
Undocumented
-
dhcpy.hookLibrary.HookLibrary.fill_from_json
dhcpy.hookLibrary.HookLibrary.html#fill_from_json
Function
Method
PUBLIC
Undocumented
-
dhcpy.dhcp_service.DhcpService
dhcpy.dhcp_service.DhcpService.html
Class
Class
PUBLIC
A class to represent a generic DHCP service, inherited from Allocator and used by the DHCP4 and DHCP6 services
-
dhcpy.dhcp_service.DhcpService.__init__
dhcpy.dhcp_service.DhcpService.html#__init__
Function
Method
PUBLIC
Initialize the object
-
dhcpy.dhcp_service.DhcpService.json_key
dhcpy.dhcp_service.DhcpService.html#json_key
Attribute
Instance Variable
PUBLIC
Initialize a DHCP service object, with empty strings and lists
-
dhcpy.dhcp_service.DhcpService.subnets
dhcpy.dhcp_service.DhcpService.html#subnets
Attribute
Instance Variable
PUBLIC
A list of Subnet objects
-
dhcpy.dhcp_service.DhcpService.control_socket
dhcpy.dhcp_service.DhcpService.html#control_socket
Attribute
Instance Variable
PUBLIC
The control socket for the DHCP service
-
dhcpy.dhcp_service.DhcpService.global_params
dhcpy.dhcp_service.DhcpService.html#global_params
Attribute
Instance Variable
PUBLIC
A dictionary of global DHCP Options for the DHCP service
-
dhcpy.dhcp_service.DhcpService.default_nameservers
dhcpy.dhcp_service.DhcpService.html#default_nameservers
Attribute
Instance Variable
PUBLIC
A list of default nameservers for the DHCP service
-
dhcpy.dhcp_service.DhcpService.option_defs
dhcpy.dhcp_service.DhcpService.html#option_defs
Attribute
Instance Variable
PUBLIC
A list of DHCP options that define the option definitions used by option_data
-
dhcpy.dhcp_service.DhcpService.subnet_ids
dhcpy.dhcp_service.DhcpService.html#subnet_ids
Attribute
Instance Variable
PUBLIC
The IDs used by the subnets in this service, so you don't reuse one and break the world
-
dhcpy.dhcp_service.DhcpService.dhcp_queue_control
dhcpy.dhcp_service.DhcpService.html#dhcp_queue_control
Attribute
Instance Variable
PUBLIC
The DHCP Queue Control Object for the DHCP service
-
dhcpy.dhcp_service.DhcpService.early_global_reservations_lookup
dhcpy.dhcp_service.DhcpService.html#early_global_reservations_lookup
Attribute
Instance Variable
PUBLIC
Whether to do an early global reservations lookup
-
dhcpy.dhcp_service.DhcpService.expired_leases_processing
dhcpy.dhcp_service.DhcpService.html#expired_leases_processing
Attribute
Instance Variable
PUBLIC
The Expired Leases Processing object for the DHCP service
-
dhcpy.dhcp_service.DhcpService.host_reservation_identifiers
dhcpy.dhcp_service.DhcpService.html#host_reservation_identifiers
Attribute
Instance Variable
PUBLIC
A list of host reservation identifiers
-
dhcpy.dhcp_service.DhcpService.hostname_char_replacement
dhcpy.dhcp_service.DhcpService.html#hostname_char_replacement
Attribute
Instance Variable
PUBLIC
The hostname character replacement because using banned characters is like a sport for some people
-
dhcpy.dhcp_service.DhcpService.hostname_char_set
dhcpy.dhcp_service.DhcpService.html#hostname_char_set
Attribute
Instance Variable
PUBLIC
The hostname character set in case you want to put your foot down
-
dhcpy.dhcp_service.DhcpService.interfaces_config
dhcpy.dhcp_service.DhcpService.html#interfaces_config
Attribute
Instance Variable
PUBLIC
The Interfaces Config object for the DHCP service
-
dhcpy.dhcp_service.DhcpService.ip_reservations_unique
dhcpy.dhcp_service.DhcpService.html#ip_reservations_unique
Attribute
Instance Variable
PUBLIC
Whether IP reservations are unique
-
dhcpy.dhcp_service.DhcpService.lease_database
dhcpy.dhcp_service.DhcpService.html#lease_database
Attribute
Instance Variable
PUBLIC
The Lease Database object for the DHCP service
-
dhcpy.dhcp_service.DhcpService.loggers
dhcpy.dhcp_service.DhcpService.html#loggers
Attribute
Instance Variable
PUBLIC
A list of Logger objects for the DHCP service
-
dhcpy.dhcp_service.DhcpService.mac_sources
dhcpy.dhcp_service.DhcpService.html#mac_sources
Attribute
Instance Variable
PUBLIC
A list of MAC sources used by DHCP service
-
dhcpy.dhcp_service.DhcpService.multi_threading
dhcpy.dhcp_service.DhcpService.html#multi_threading
Attribute
Instance Variable
PUBLIC
The Multi Threading object for the DHCP service, sets the threading options
-
dhcpy.dhcp_service.DhcpService.relay_supplied_options
dhcpy.dhcp_service.DhcpService.html#relay_supplied_options
Attribute
Instance Variable
PUBLIC
A list of the DHCP Options supplied by the relay
-
dhcpy.dhcp_service.DhcpService.sanity_checks
dhcpy.dhcp_service.DhcpService.html#sanity_checks
Attribute
Instance Variable
PUBLIC
The Sanity Checks object for the DHCP service, these are the checks that are done to make sure the service is not insane
-
dhcpy.dhcp_service.DhcpService.server_id
dhcpy.dhcp_service.DhcpService.html#server_id
Attribute
Instance Variable
PUBLIC
The Server ID object for the DHCP service
-
dhcpy.dhcp_service.DhcpService.server_tag
dhcpy.dhcp_service.DhcpService.html#server_tag
Attribute
Instance Variable
PUBLIC
The server tag for the DHCP service
-
dhcpy.dhcp_service.DhcpService.statistic_default_sample_age
dhcpy.dhcp_service.DhcpService.html#statistic_default_sample_age
Attribute
Instance Variable
PUBLIC
The default sample age for statistics
-
dhcpy.dhcp_service.DhcpService.statistic_default_sample_count
dhcpy.dhcp_service.DhcpService.html#statistic_default_sample_count
Attribute
Instance Variable
PUBLIC
The default sample count for statistics
-
dhcpy.dhcp_service.DhcpService.store_extended_info
dhcpy.dhcp_service.DhcpService.html#store_extended_info
Attribute
Instance Variable
PUBLIC
Whether to store extended lease info
-
dhcpy.dhcp_service.DhcpService.client_classes 0
dhcpy.dhcp_service.DhcpService.html#client_classes%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.DhcpService.client_classes
dhcpy.dhcp_service.DhcpService.html#client_classes
Attribute
Property
PUBLIC
the client classes
-
dhcpy.dhcp_service.DhcpService.client_classes.setter
dhcpy.dhcp_service.DhcpService.html#client_classes.setter
Function
Method
PUBLIC
set the client classes
-
dhcpy.dhcp_service.DhcpService._client_classes
dhcpy.dhcp_service.DhcpService.html#_client_classes
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.DhcpService.add_client_class
dhcpy.dhcp_service.DhcpService.html#add_client_class
Function
Method
PUBLIC
Add a client class to the service
-
dhcpy.dhcp_service.DhcpService.reservations_global 0
dhcpy.dhcp_service.DhcpService.html#reservations_global%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_global
dhcpy.dhcp_service.DhcpService.html#reservations_global
Attribute
Property
PUBLIC
fetch global reservations. If true, reservations are global, if false, they are not
-
dhcpy.dhcp_service.DhcpService.reservations_global.setter
dhcpy.dhcp_service.DhcpService.html#reservations_global.setter
Function
Method
PUBLIC
set global reservations. If true, reservations are global, if false, they are not
-
dhcpy.dhcp_service.DhcpService._reservations_global
dhcpy.dhcp_service.DhcpService.html#_reservations_global
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_in_subnet 0
dhcpy.dhcp_service.DhcpService.html#reservations_in_subnet%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_in_subnet
dhcpy.dhcp_service.DhcpService.html#reservations_in_subnet
Attribute
Property
PUBLIC
fetch reservations in subnet. If true, reservations are in subnet, if false, they are not
-
dhcpy.dhcp_service.DhcpService.reservations_in_subnet.setter
dhcpy.dhcp_service.DhcpService.html#reservations_in_subnet.setter
Function
Method
PUBLIC
set reservations in subnet. If true, reservations are in subnet, if false, they are not
-
dhcpy.dhcp_service.DhcpService._reservations_in_subnet
dhcpy.dhcp_service.DhcpService.html#_reservations_in_subnet
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_lookup_first 0
dhcpy.dhcp_service.DhcpService.html#reservations_lookup_first%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_lookup_first
dhcpy.dhcp_service.DhcpService.html#reservations_lookup_first
Attribute
Property
PUBLIC
controls whether host reservations lookup should be performed before lease lookup
-
dhcpy.dhcp_service.DhcpService.reservations_lookup_first.setter
dhcpy.dhcp_service.DhcpService.html#reservations_lookup_first.setter
Function
Method
PUBLIC
set whether host reservations lookup should be performed before lease lookup
-
dhcpy.dhcp_service.DhcpService._reservations_lookup_first
dhcpy.dhcp_service.DhcpService.html#_reservations_lookup_first
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_out_of_pool 0
dhcpy.dhcp_service.DhcpService.html#reservations_out_of_pool%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.DhcpService.reservations_out_of_pool
dhcpy.dhcp_service.DhcpService.html#reservations_out_of_pool
Attribute
Property
PUBLIC
controls whether host reservations can be made outside the pool when reservations-in-subnet is true
-
dhcpy.dhcp_service.DhcpService.reservations_out_of_pool.setter
dhcpy.dhcp_service.DhcpService.html#reservations_out_of_pool.setter
Function
Method
PUBLIC
set whether host reservations can be made outside the pool when reservations-in-subnet is true
-
dhcpy.dhcp_service.DhcpService._reservations_out_of_pool
dhcpy.dhcp_service.DhcpService.html#_reservations_out_of_pool
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.DhcpService.hook_libraries 0
dhcpy.dhcp_service.DhcpService.html#hook_libraries%200
Attribute
Instance Variable
PUBLIC
The KEA plugins on this server
-
dhcpy.dhcp_service.DhcpService.hook_libraries
dhcpy.dhcp_service.DhcpService.html#hook_libraries
Attribute
Property
PUBLIC
The KEA plugins on this server
-
dhcpy.dhcp_service.DhcpService.hook_libraries.setter
dhcpy.dhcp_service.DhcpService.html#hook_libraries.setter
Function
Method
PUBLIC
Set the KEA plugins on this server
-
dhcpy.dhcp_service.DhcpService._hook_libraries
dhcpy.dhcp_service.DhcpService.html#_hook_libraries
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.DhcpService.add_hook_library
dhcpy.dhcp_service.DhcpService.html#add_hook_library
Function
Method
PUBLIC
Add a KEA plugin to the server
-
dhcpy.dhcp_service.DhcpService.__dict__
dhcpy.dhcp_service.DhcpService.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the service, for making JSON in the format KEA expects
-
dhcpy.dhcp_service.DhcpService.update_service
dhcpy.dhcp_service.DhcpService.html#update_service
Function
Method
PUBLIC
Send the service to the server
-
dhcpy.dhcp_service.Dhcp4Service
dhcpy.dhcp_service.Dhcp4Service.html
Class
Class
PUBLIC
A class to represent a DHCP4 service, inherited from DhcpService
-
dhcpy.dhcp_service.Dhcp4Service.__init__
dhcpy.dhcp_service.Dhcp4Service.html#__init__
Function
Method
PUBLIC
Initialize a DHCP4 service object, with empty strings and lists
-
dhcpy.dhcp_service.Dhcp4Service.control_socket
dhcpy.dhcp_service.Dhcp4Service.html#control_socket
Attribute
Instance Variable
PUBLIC
The control socket for the DHCP4 service
-
dhcpy.dhcp_service.Dhcp6Service
dhcpy.dhcp_service.Dhcp6Service.html
Class
Class
PUBLIC
A class to represent a DHCP6 service, inherited from DhcpService
-
dhcpy.dhcp_service.Dhcp6Service.__init__
dhcpy.dhcp_service.Dhcp6Service.html#__init__
Function
Method
PUBLIC
Initialize a DHCP6 service object, with empty strings and lists
-
dhcpy.dhcp_service.Dhcp6Service.json_key
dhcpy.dhcp_service.Dhcp6Service.html#json_key
Attribute
Instance Variable
PUBLIC
Initialize a DHCP service object, with empty strings and lists
-
dhcpy.dhcp_service.Dhcp6Service.control_socket
dhcpy.dhcp_service.Dhcp6Service.html#control_socket
Attribute
Instance Variable
PUBLIC
The control socket for the DHCP6 service
-
dhcpy.dhcp_service.Dhcp6Service.pd_allocator
dhcpy.dhcp_service.Dhcp6Service.html#pd_allocator
Attribute
Instance Variable
PUBLIC
The allocator for prefix delegation (in a row or just all over the place)
-
dhcpy.dhcp_service.Dhcp6Service.dhcp4o6_port 0
dhcpy.dhcp_service.Dhcp6Service.html#dhcp4o6_port%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.Dhcp6Service.dhcp4o6_port
dhcpy.dhcp_service.Dhcp6Service.html#dhcp4o6_port
Attribute
Property
PUBLIC
The port for DHCP4 over DHCP6
-
dhcpy.dhcp_service.Dhcp6Service.dhcp4o6_port.setter
dhcpy.dhcp_service.Dhcp6Service.html#dhcp4o6_port.setter
Function
Method
PUBLIC
Set the port for DHCP4 over DHCP6
-
dhcpy.dhcp_service.Dhcp6Service._dhcp4o6_port
dhcpy.dhcp_service.Dhcp6Service.html#_dhcp4o6_port
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.Dhcp6Service.subnets 0
dhcpy.dhcp_service.Dhcp6Service.html#subnets%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.dhcp_service.Dhcp6Service.subnets
dhcpy.dhcp_service.Dhcp6Service.html#subnets
Attribute
Instance Variable
PUBLIC
A list of Subnet objects
-
dhcpy.dhcp_service.Dhcp6Service.subnets.setter
dhcpy.dhcp_service.Dhcp6Service.html#subnets.setter
Function
Method
PUBLIC
Undocumented
-
dhcpy.dhcp_service.Dhcp6Service._subnets
dhcpy.dhcp_service.Dhcp6Service.html#_subnets
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.dhcp_service.Dhcp6Service.add_subnet
dhcpy.dhcp_service.Dhcp6Service.html#add_subnet
Function
Method
PUBLIC
Add a subnet to the service
-
dhcpy.dhcp_service.Dhcp6Service.__dict__
dhcpy.dhcp_service.Dhcp6Service.html#__dict__
Function
Method
PUBLIC
Return a dictionary representation of the service, for making JSON in the format KEA expects
-
dhcpy.dhcp_service.Dhcp6Service.get_config
dhcpy.dhcp_service.Dhcp6Service.html#get_config
Function
Method
PUBLIC
Get the v6 settings of the server
-
dhcpy.dhcp_service.Dhcp6Service.client_classes
dhcpy.dhcp_service.Dhcp6Service.html#client_classes
Attribute
Instance Variable
PUBLIC
the client classes
-
dhcpy.server.Server
dhcpy.server.Server.html
Class
Class
PUBLIC
A KEA server, with an IP address, hostname, and interfaces
-
dhcpy.server.Server.__init__
dhcpy.server.Server.html#__init__
Function
Method
PUBLIC
Undocumented
-
dhcpy.server.Server.mgmt_ip4
dhcpy.server.Server.html#mgmt_ip4
Attribute
Instance Variable
PUBLIC
The IPv4 address used the manage the server. This is not neccessarily the IP address used by the DHCP service
-
dhcpy.server.Server.v4_socket
dhcpy.server.Server.html#v4_socket
Attribute
Instance Variable
PUBLIC
The control socket for the DHCP6 service. Set to the default value. You can change it if you need to.
-
dhcpy.server.Server.mgmt_ip6
dhcpy.server.Server.html#mgmt_ip6
Attribute
Instance Variable
PUBLIC
The IPv6 address used the manage the server. This is not neccessarily the IP address used by the DHCP service
-
dhcpy.server.Server.v6_socket
dhcpy.server.Server.html#v6_socket
Attribute
Instance Variable
PUBLIC
The control socket for the DHCP6 service. Set to the default value. You can change it if you need to.
-
dhcpy.server.Server.hostname
dhcpy.server.Server.html#hostname
Attribute
Instance Variable
PUBLIC
The hostname of the server, if your into that whole DNS thing
-
dhcpy.server.Server.interfaces
dhcpy.server.Server.html#interfaces
Attribute
Instance Variable
PUBLIC
A list of interfaces on the server. These are the names used by KEA to identify the interfaces
-
dhcpy.server.Server.v6_allocator
dhcpy.server.Server.html#v6_allocator
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.server.Server.calculate_tee_times
dhcpy.server.Server.html#calculate_tee_times
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.server.Server.client_classes
dhcpy.server.Server.html#client_classes
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.server.Server.option_defs
dhcpy.server.Server.html#option_defs
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.server.Server.dhcp_v6_service
dhcpy.server.Server.html#dhcp_v6_service
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.server.Server.subnet_ids 0
dhcpy.server.Server.html#subnet_ids%200
Attribute
Instance Variable
PUBLIC
Undocumented
-
dhcpy.server.Server.subnet_ids
dhcpy.server.Server.html#subnet_ids
Attribute
Property
PUBLIC
Undocumented
-
dhcpy.server.Server.subnet_ids.setter
dhcpy.server.Server.html#subnet_ids.setter
Function
Method
PUBLIC
Undocumented
-
dhcpy.server.Server._subnet_ids
dhcpy.server.Server.html#_subnet_ids
Attribute
Instance Variable
PRIVATE
Undocumented
-
dhcpy.server.Server.subnets
dhcpy.server.Server.html#subnets
Attribute
Property
PUBLIC
Undocumented
-
dhcpy.server.Server.get_config
dhcpy.server.Server.html#get_config
Function
Method
PUBLIC
Get the configuration of the server
-
dhcpy.server.Server.get_v6_config
dhcpy.server.Server.html#get_v6_config
Function
Method
PUBLIC
Get the v6 settings of the server
-
dhcpy.server.Server.get_v4_config
dhcpy.server.Server.html#get_v4_config
Function
Method
PUBLIC
Get the v6 settings of the server
-
dhcpy.server.Server.save_config
dhcpy.server.Server.html#save_config
Function
Method
PUBLIC
Write the configuration to the server :return: the reply from kea