openstack
/
neutron
Code Issues Proposed changes

Add docstrings for ip_lib IP address methods 

Add docstrings for the newly added IP address methods.
Also changed the argument order to be more like the
other methods in the module, which is Ok since the
only consumer is in the file itself.

Trivialfix

Change-Id: I36dfafd80c0ea854bc780199a33671e0da697fca
This commit is contained in:
Brian Haley 2018-03-16 12:12:12 -04:00
parent ecc60df945
commit 4472b0f439
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
neutron/agent/linux/ip_lib.py
View File

@ -576,15 +576,14 @@ class IpAddrCommand(IpDeviceCommandBase):
COMMAND = 'addr'
def add(self, cidr, scope='global', add_broadcast=True):
add_ip_address(self.name, self._parent.namespace, cidr, scope,
add_ip_address(cidr, self.name, self._parent.namespace, scope,
add_broadcast)
def delete(self, cidr):
delete_ip_address(self.name, self._parent.namespace, cidr)
delete_ip_address(cidr, self.name, self._parent.namespace)
def flush(self, ip_version):
flush_ip_addresses(
self.name, self._parent.namespace, ip_version)
flush_ip_addresses(ip_version, self.name, self._parent.namespace)
def get_devices_with_ip(self, name=None, scope=None, to=None,
filters=None, ip_version=None):
@ -950,8 +949,16 @@ NetworkNamespaceNotFound = privileged.NetworkNamespaceNotFound
NetworkInterfaceNotFound = privileged.NetworkInterfaceNotFound
def add_ip_address(device, namespace, cidr, scope='global',
def add_ip_address(cidr, device, namespace=None, scope='global',
add_broadcast=True):
"""Add an IP address.
:param cidr: IP address to add, in CIDR notation
:param device: Device name to use in adding address
:param namespace: The name of the namespace in which to add the address
:param scope: scope of address being added
:param add_broadcast: should broadcast address be added
"""
net = netaddr.IPNetwork(cidr)
broadcast = None
if add_broadcast and net.version == 4:
@ -963,15 +970,26 @@ def add_ip_address(device, namespace, cidr, scope='global',
device, namespace, scope, broadcast)
def delete_ip_address(device, namespace, cidr):
def delete_ip_address(cidr, device, namespace=None):
"""Delete an IP address.
:param cidr: IP address to delete, in CIDR notation
:param device: Device name to use in deleting address
:param namespace: The name of the namespace in which to delete the address
"""
net = netaddr.IPNetwork(cidr)
privileged.delete_ip_address(
net.version, str(net.ip), net.prefixlen, device, namespace)
def flush_ip_addresses(device, namespace, ip_version):
privileged.flush_ip_addresses(
ip_version, device, namespace)
def flush_ip_addresses(ip_version, device, namespace=None):
"""Flush all IP addresses.
:param ip_version: IP version of addresses to flush
:param device: Device name to use in flushing addresses
:param namespace: The name of the namespace in which to flush the addresses
"""
privileged.flush_ip_addresses(ip_version, device, namespace)
def get_routing_table(ip_version, namespace=None):