Add nicer client handling of DHCP leases

This commit is contained in:
Joshua Boniface 2018-10-02 00:02:23 -04:00
parent 29a194f27d
commit 3302088f34
2 changed files with 110 additions and 91 deletions

View File

@ -771,39 +771,43 @@ def net_dhcp_add(net, ipaddr, macaddr, hostname):
############################################################################### ###############################################################################
# pvc network dhcp remove # pvc network dhcp remove
############################################################################### ###############################################################################
@click.command(name='remove', short_help='Remove a DHCP reservation from a virtual network.') @click.command(name='remove', short_help='Remove a DHCP lease from a virtual network.')
@click.argument( @click.argument(
'net' 'net'
) )
@click.argument( @click.argument(
'reservation' 'lease'
) )
def net_dhcp_remove(net, reservation): def net_dhcp_remove(net, lease):
""" """
Remove a DHCP reservation RESERVATION from virtual network NET; RESERVATION can be either a MAC address, an IP address, or a description; NET can be either a VNI or description. Remove a DHCP lease (or reservation) LEASE from virtual network NET; LEASE can be either a MAC address, an IP address, or a hostname; NET can be either a VNI or description.
""" """
zk_conn = pvc_common.startZKConnection(zk_host) zk_conn = pvc_common.startZKConnection(zk_host)
retcode, retmsg = pvc_network.remove_dhcp_reservation(zk_conn, net, reservation) retcode, retmsg = pvc_network.remove_dhcp_lease(zk_conn, net, lease)
cleanup(retcode, retmsg, zk_conn) cleanup(retcode, retmsg, zk_conn)
############################################################################### ###############################################################################
# pvc network dhcp list # pvc network dhcp list
############################################################################### ###############################################################################
@click.command(name='list', short_help='List all DHCP reservation objects.') @click.command(name='list', short_help='List DHCP lease objects.')
@click.option(
'-r', '--reservations', 'only_reservations', is_flag=True, default=False,
help='Show only static reservations instead of all leases.'
)
@click.argument( @click.argument(
'net' 'net'
) )
@click.argument( @click.argument(
'limit', default=None, required=False 'limit', default=None, required=False
) )
def net_dhcp_list(net, limit): def net_dhcp_list(net, limit, only_reservations):
""" """
List all DHCP reservations in virtual network NET; optionally only match elements matching regex LIMIT; NET can be either a VNI or description. List all DHCP leases in virtual network NET; optionally only match elements matching regex LIMIT; NET can be either a VNI or description.
""" """
zk_conn = pvc_common.startZKConnection(zk_host) zk_conn = pvc_common.startZKConnection(zk_host)
retcode, retmsg = pvc_network.get_list_dhcp_reservations(zk_conn, net, limit) retcode, retmsg = pvc_network.get_list_dhcp_leases(zk_conn, net, limit, only_reservations=only_reservations)
cleanup(retcode, retmsg, zk_conn) cleanup(retcode, retmsg, zk_conn)
############################################################################### ###############################################################################

View File

@ -100,12 +100,17 @@ def getNetworkDescription(zk_conn, network):
return net_description return net_description
def getNetworkDHCPLeases(zk_conn, vni):
# Get a list of DHCP leases by listing the children of /networks/<vni>/dhcp_leases
dhcp_leases = zk_conn.get_children('/networks/{}/dhcp_leases'.format(vni))
return sorted(dhcp_leases)
def getNetworkDHCPReservations(zk_conn, vni): def getNetworkDHCPReservations(zk_conn, vni):
# Get a list of VNIs by listing the children of /networks/<vni>/dhcp_leases # Get a list of VNIs by listing the children of /networks/<vni>/dhcp_leases
dhcp_reservations = [] dhcp_reservations = []
dhcp_leases = zk_conn.get_children('/networks/{}/dhcp_leases'.format(vni)) dhcp_leases = getNetworkDHCPLeases(zk_conn, vni)
for lease in dhcp_leases: for lease in dhcp_leases:
timestamp = zkhandler.readdata(zk_conn, lease) timestamp = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}'.format (vni, lease))
if timestamp == 'static': if timestamp == 'static':
dhcp_reservations.append(lease) dhcp_reservations.append(lease)
return sorted(dhcp_reservations) return sorted(dhcp_reservations)
@ -124,11 +129,11 @@ def getNetworkInformation(zk_conn, vni):
dhcp_end = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_end'.format(vni)) dhcp_end = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_end'.format(vni))
return description, domain, ip_network, ip_gateway, dhcp_flag, dhcp_start, dhcp_end return description, domain, ip_network, ip_gateway, dhcp_flag, dhcp_start, dhcp_end
def getDHCPReservationInformation(zk_conn, vni, macaddr): def getDHCPLeaseInformation(zk_conn, vni, mac_address):
hostname = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/hostname'.format(vni, macaddr)) hostname = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/hostname'.format(vni, mac_address))
ip_address = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/ipaddr'.format(vni, macaddr)) ip_address = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/ipaddr'.format(vni, mac_address))
mac_address = macaddr timestamp = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}'.format(vni, mac_address))
return hostname, ip_address, mac_address return hostname, ip_address, mac_address, timestamp
def formatNetworkInformation(zk_conn, vni, long_output): def formatNetworkInformation(zk_conn, vni, long_output):
description, domain, ip_network, ip_gateway, dhcp_flag, dhcp_start, dhcp_end = getNetworkInformation(zk_conn, vni) description, domain, ip_network, ip_gateway, dhcp_flag, dhcp_start, dhcp_end = getNetworkInformation(zk_conn, vni)
@ -154,17 +159,13 @@ def formatNetworkInformation(zk_conn, vni, long_output):
ainformation.append('{}DHCP range:{} {} - {}'.format(ansiiprint.purple(), ansiiprint.end(), dhcp_start, dhcp_end)) ainformation.append('{}DHCP range:{} {} - {}'.format(ansiiprint.purple(), ansiiprint.end(), dhcp_start, dhcp_end))
if long_output: if long_output:
dhcp_leases = zk_conn.get_children('/networks/{}/dhcp_leases'.format(vni)) dhcp_reservations_list = getNetworkDHCPReservations(zk_conn, vni)
dhcp_reservations_list = []
for lease in dhcp_leases:
description = zkhandler.readdata(zk_conn, lease)
if description == 'static':
dhcp_reservations_list.append(lease)
if dhcp_reservations_list: if dhcp_reservations_list:
ainformation.append('') ainformation.append('')
ainformation.append('{}Client DHCP reservations:{}'.format(ansiiprint.bold(), ansiiprint.end())) ainformation.append('{}Client DHCP reservations:{}'.format(ansiiprint.bold(), ansiiprint.end()))
ainformation.append('') ainformation.append('')
dhcp_reservations_string = formatDHCPReservationList(zk_conn, vni, dhcp_reservations_list) # Only show static reservations in the detailed information
dhcp_reservations_string = formatDHCPLeaseList(zk_conn, vni, dhcp_reservations_list)
for line in dhcp_reservations_string.split('\n'): for line in dhcp_reservations_string.split('\n'):
ainformation.append(line) ainformation.append(line)
@ -299,71 +300,77 @@ def formatNetworkList(zk_conn, net_list):
output_string = net_list_output_header + '\n' + '\n'.join(sorted(net_list_output)) output_string = net_list_output_header + '\n' + '\n'.join(sorted(net_list_output))
return output_string return output_string
def formatDHCPReservationList(zk_conn, vni, dhcp_reservations_list): def formatDHCPLeaseList(zk_conn, vni, dhcp_leases_list):
dhcp_reservation_list_output = [] dhcp_lease_list_output = []
hostname = {} hostname = {}
ip_address = {} ip_address = {}
mac_address = {} mac_address = {}
timestamp = {}
# Gather information for printing # Gather information for printing
for dhcp_reservation in dhcp_reservations_list: for dhcp_lease in dhcp_leases_list:
# get info # get info
hostname[dhcp_reservation], ip_address[dhcp_reservation], mac_address[dhcp_reservation] = getDHCPReservationInformation(zk_conn, vni, dhcp_reservation) hostname[dhcp_lease], ip_address[dhcp_lease], mac_address[dhcp_lease], timestamp[dhcp_lease] = getDHCPLeaseInformation(zk_conn, vni, dhcp_lease)
# Determine optimal column widths # Determine optimal column widths
# Dynamic columns: node_name, hypervisor, migrated lease_hostname_length = 13
reservation_hostname_length = 13 lease_ip_address_length = 11
reservation_ip_address_length = 11 lease_mac_address_length = 13
reservation_mac_address_length = 13 for dhcp_lease in dhcp_leases_list:
for dhcp_reservation in dhcp_reservations_list:
# hostname column # hostname column
_reservation_hostname_length = len(hostname[dhcp_reservation]) + 1 _lease_hostname_length = len(hostname[dhcp_lease]) + 1
if _reservation_hostname_length > reservation_hostname_length: if _lease_hostname_length > lease_hostname_length:
reservation_hostname_length = _reservation_hostname_length lease_hostname_length = _lease_hostname_length
# ip_network column # ip_network column
_reservation_ip_address_length = len(ip_address[dhcp_reservation]) + 1 _lease_ip_address_length = len(ip_address[dhcp_lease]) + 1
if _reservation_ip_address_length > reservation_ip_address_length: if _lease_ip_address_length > lease_ip_address_length:
reservation_ip_address_length = _reservation_ip_address_length lease_ip_address_length = _lease_ip_address_length
# ip_gateway column # ip_gateway column
_reservation_mac_address_length = len(mac_address[dhcp_reservation]) + 1 _lease_mac_address_length = len(mac_address[dhcp_lease]) + 1
if _reservation_mac_address_length > reservation_mac_address_length: if _lease_mac_address_length > lease_mac_address_length:
reservation_mac_address_length = _reservation_mac_address_length lease_mac_address_length = _lease_mac_address_length
# Format the string (header) # Format the string (header)
dhcp_reservation_list_output_header = '{bold}\ dhcp_lease_list_output_header = '{bold}\
{reservation_hostname: <{reservation_hostname_length}} \ {lease_hostname: <{lease_hostname_length}} \
{reservation_ip_address: <{reservation_ip_address_length}} \ {lease_ip_address: <{lease_ip_address_length}} \
{reservation_mac_address: <{reservation_mac_address_length}} \ {lease_mac_address: <{lease_mac_address_length}} \
{lease_timestamp: <{lease_timestamp_length}} \
{end_bold}'.format( {end_bold}'.format(
bold=ansiiprint.bold(), bold=ansiiprint.bold(),
end_bold=ansiiprint.end(), end_bold=ansiiprint.end(),
reservation_hostname_length=reservation_hostname_length, lease_hostname_length=lease_hostname_length,
reservation_ip_address_length=reservation_ip_address_length, lease_ip_address_length=lease_ip_address_length,
reservation_mac_address_length=reservation_mac_address_length, lease_mac_address_length=lease_mac_address_length,
reservation_hostname='Hostname', lease_timestamp_length=12,
reservation_ip_address='IP Address', lease_hostname='Hostname',
reservation_mac_address='MAC Address' lease_ip_address='IP Address',
lease_mac_address='MAC Address',
lease_timestamp='Timestamp'
) )
for dhcp_reservation in dhcp_reservations_list: for dhcp_lease in dhcp_leases_list:
dhcp_reservation_list_output.append('{bold}\ dhcp_lease_list_output.append('{bold}\
{reservation_hostname: <{reservation_hostname_length}} \ {lease_hostname: <{lease_hostname_length}} \
{reservation_ip_address: <{reservation_ip_address_length}} \ {lease_ip_address: <{lease_ip_address_length}} \
{reservation_mac_address: <{reservation_mac_address_length}} \ {lease_mac_address: <{lease_mac_address_length}} \
{lease_timestamp: <{lease_timestamp_length}} \
{end_bold}'.format( {end_bold}'.format(
bold='', bold='',
end_bold='', end_bold='',
reservation_hostname_length=reservation_hostname_length, lease_hostname_length=lease_hostname_length,
reservation_ip_address_length=reservation_ip_address_length, lease_ip_address_length=lease_ip_address_length,
reservation_mac_address_length=reservation_mac_address_length, lease_mac_address_length=lease_mac_address_length,
reservation_hostname=hostname[dhcp_reservation], lease_timestamp_length=12,
reservation_ip_address=ip_address[dhcp_reservation], lease_hostname=hostname[dhcp_lease],
reservation_mac_address=mac_address[dhcp_reservation] lease_ip_address=ip_address[dhcp_lease],
lease_mac_address=mac_address[dhcp_lease],
lease_timestamp=timestamp[dhcp_lease]
) )
) )
output_string = dhcp_reservation_list_output_header + '\n' + '\n'.join(sorted(dhcp_reservation_list_output)) output_string = dhcp_lease_list_output_header + '\n' + '\n'.join(sorted(dhcp_lease_list_output))
return output_string return output_string
def isValidMAC(macaddr): def isValidMAC(macaddr):
@ -484,7 +491,7 @@ def add_dhcp_reservation(zk_conn, network, ipaddress, macaddress, hostname):
return True, 'DHCP reservation "{}" added successfully!'.format(macaddress) return True, 'DHCP reservation "{}" added successfully!'.format(macaddress)
def remove_dhcp_reservation(zk_conn, network, reservation): def remove_dhcp_lease(zk_conn, network, lease):
# Validate and obtain standard passed value # Validate and obtain standard passed value
net_vni = getNetworkVNI(zk_conn, network) net_vni = getNetworkVNI(zk_conn, network)
if net_vni == None: if net_vni == None:
@ -493,18 +500,15 @@ def remove_dhcp_reservation(zk_conn, network, reservation):
match_description = '' match_description = ''
# Check if the reservation matches a description, a mac, or an IP address currently in the database # Check if the reservation matches a description, a mac, or an IP address currently in the database
reservation_list = zk_conn.get_children('/networks/{}/dhcp_leases'.format(net_vni)) dhcp_leases_list = zk_conn.get_children('/networks/{}/dhcp_leases'.format(net_vni))
for macaddr in reservation_list: for macaddr in dhcp_leases_list:
timestamp = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}'.format(net_vni, macaddr))
if timestamp != 'static':
continue
hostname = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/hostname'.format(net_vni, macaddr)) hostname = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/hostname'.format(net_vni, macaddr))
ipaddress = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/ipaddr'.format(net_vni, macaddr)) ipaddress = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}/ipaddr'.format(net_vni, macaddr))
if reservation == macaddr or reservation == hostname or reservation == ipaddress: if lease == macaddr or lease == hostname or lease == ipaddress:
match_description = macaddr match_description = macaddr
if not match_description: if not match_description:
return False, 'ERROR: No DHCP reservation exists matching "{}"!'.format(reservation) return False, 'ERROR: No DHCP lease exists matching "{}"!'.format(reservation)
# Remove the entry from zookeeper # Remove the entry from zookeeper
try: try:
@ -512,7 +516,7 @@ def remove_dhcp_reservation(zk_conn, network, reservation):
except: except:
return False, 'ERROR: Failed to write to Zookeeper!' return False, 'ERROR: Failed to write to Zookeeper!'
return True, 'DHCP reservation "{}" removed successfully!'.format(match_description) return True, 'DHCP lease "{}" removed successfully!'.format(match_description)
def get_info(zk_conn, network, long_output): def get_info(zk_conn, network, long_output):
# Validate and obtain alternate passed value # Validate and obtain alternate passed value
@ -554,34 +558,45 @@ def get_list(zk_conn, limit):
return True, '' return True, ''
def get_list_dhcp_reservations(zk_conn, network, limit): def get_list_dhcp_leases(zk_conn, network, limit, only_reservations=False):
# Validate and obtain alternate passed value # Validate and obtain alternate passed value
net_vni = getNetworkVNI(zk_conn, network) net_vni = getNetworkVNI(zk_conn, network)
if net_vni == None: if net_vni == None:
return False, 'ERROR: Could not find network "{}" in the cluster!'.format(network) return False, 'ERROR: Could not find network "{}" in the cluster!'.format(network)
dhcp_reservations_list = [] dhcp_leases_list = []
full_dhcp_reservations_list = zk_conn.get_children('/networks/{}/dhcp_reservations'.format(net_vni)) full_dhcp_leases_list = getNetworkDHCPLeases(zk_conn, net_vni)
for dhcp_reservation in full_dhcp_reservations_list: if limit:
if limit != None: try:
try: # Implcitly assume fuzzy limits
# Implcitly assume fuzzy limits if re.match('\^.*', limit) == None:
if re.match('\^.*', limit) == None: limit = '.*' + limit
limit = '.*' + limit if re.match('.*\$', limit) == None:
if re.match('.*\$', limit) == None: limit = limit + '.*'
limit = limit + '.*' except Exception as e:
return False, 'Regex Error: {}'.format(e)
if re.match(limit, net) != None: for lease in full_dhcp_leases_list:
dhcp_reservations_list.append(dhcp_reservation) valid_lease = False
if re.match(limit, description) != None: if only_reservations:
dhcp_reservations_list.append(dhcp_reservation) lease_timestamp = zkhandler.readdata(zk_conn, '/networks/{}/dhcp_leases/{}'.format(net_vni, lease))
except Exception as e: if lease_timestamp == 'static':
return False, 'Regex Error: {}'.format(e) if limit:
if re.match(limit, lease) != None:
valid_lease = True
if re.match(limit, lease) != None:
valid_lease = True
else:
valid_lease = True
else: else:
dhcp_reservations_list.append(dhcp_reservation) valid_lease = True
output_string = formatDHCPReservationList(zk_conn, net_vni, dhcp_reservations_list) if valid_lease:
dhcp_leases_list.append(lease)
output_string = formatDHCPLeaseList(zk_conn, net_vni, dhcp_leases_list)
click.echo(output_string) click.echo(output_string)
return True, '' return True, ''