All Documents

• dhcpy
  index.html
  Package
  Package
  PUBLIC
  Tools for managing a KEA DHCP server.
• 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.subnet
  dhcpy.subnet.html
  Module
  Module
  PUBLIC
  KEA subnet pools
• 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 is should definitely return something...
• 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.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.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.subnet.subnet_type
  dhcpy.subnet.subnet_type.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.subnet.subnet_type.none
  dhcpy.subnet.subnet_type.html#none
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• dhcpy.subnet.subnet_type.v4
  dhcpy.subnet.subnet_type.html#v4
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• dhcpy.subnet.subnet_type.v6
  dhcpy.subnet.subnet_type.html#v6
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• dhcpy.subnet.subnet_type.pd
  dhcpy.subnet.subnet_type.html#pd
  Attribute
  Class Variable
  PUBLIC
  Undocumented
• dhcpy.subnet.Pool
  dhcpy.subnet.Pool.html
  Class
  Class
  PUBLIC
  No class docstring; 2/2 properties, 0/2 instance variable, 4/4 methods documented
• dhcpy.subnet.Pool.__init__
  dhcpy.subnet.Pool.html#__init__
  Function
  Method
  PUBLIC
  Initialize a pool object :param ip_range: A string in the format "Start-End" :param subnet: A string in the format "Network/CIDR" or Network/Netmask" or an ipaddress.IPNetwork object
• dhcpy.subnet.Pool.subnet
  dhcpy.subnet.Pool.html#subnet
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• dhcpy.subnet.Pool.subnet_type
  dhcpy.subnet.Pool.html#subnet_type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• dhcpy.subnet.Pool.__dict__
  dhcpy.subnet.Pool.html#__dict__
  Function
  Method
  PUBLIC
  Return a dictionary representation of the pool, for making JSON in the format KEA expects
• dhcpy.subnet.Pool.ip_range
  dhcpy.subnet.Pool.html#ip_range
  Attribute
  Property
  PUBLIC
  Return the IP range as a string in the format "Start-End"
• dhcpy.subnet.Pool.network
  dhcpy.subnet.Pool.html#network
  Attribute
  Property
  PUBLIC
  Return the network of the subnet
• dhcpy.subnet.Pool.ip_range.setter
  dhcpy.subnet.Pool.html#ip_range.setter
  Function
  Method
  PUBLIC
  Set the IP range from a string in the format "Start-End"
• dhcpy.subnet.Pool.ip_range.deleter
  dhcpy.subnet.Pool.html#ip_range.deleter
  Function
  Method
  PUBLIC
  Delete the IP range. Don't do this, becuae it doesn't do anything.
• dhcpy.subnet.Subnet
  dhcpy.subnet.Subnet.html
  Class
  Class
  PUBLIC
  No class docstring; 4/4 instance variables, 2/2 methods documented
• 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.__dict__
  dhcpy.subnet.Subnet.html#__dict__
  Function
  Method
  PUBLIC
  Return a dictionary representation of the subnet, for making JSON in the format KEA expects