ganeti.netutils.IPAddress

class documentation

class IPAddress(object):

Class that represents an IP address.

Class Method	`InNetwork`	Determine whether an address is within a network.
Class Method	`IsLoopback`	Determine whether it is a loopback address.
Class Method	`IsValid`	Validate a IP address.
Class Method	`Own`	Check if the current host has the the given IP address.
Class Method	`ValidateNetmask`	Validate a netmask suffix in CIDR notation.
Static Method	`GetAddressFamily`	Get the address family of the given address.
Static Method	`GetAddressFamilyFromVersion`	Convert an IP version to the corresponding IP address family.
Static Method	`GetClassFromIpFamily`	Return the IPAddress subclass for the given IP family.
Static Method	`GetClassFromIpVersion`	Return the IPAddress subclass for the given IP version.
Static Method	`GetVersionFromAddressFamily`	Convert an IP address family to the corresponding IP version.
Class Variable	`family`	Undocumented
Class Variable	`iplen`	Undocumented
Class Variable	`loopback_cidr`	Undocumented
Static Method	`_GetIPIntFromString`	Abstract method to please pylint.

@classmethod
def InNetwork(cls, cidr, address): ¶

Determine whether an address is within a network.

Parameters
cidr:string	Network in CIDR notation, e.g. '192.0.2.0/24', '2001:db8::/64'
address:str	IP address
Returns
bool	True if address is in cidr, False otherwise

@classmethod
def IsLoopback(cls, address): ¶

Determine whether it is a loopback address.

Parameters
address:str	IP address to be checked
Returns
bool	True if loopback, False otherwise

@classmethod
def IsValid(cls, address): ¶

Validate a IP address.

Parameters
address:str	IP address to be checked
Returns
bool	True if valid, False otherwise

@classmethod
def Own(cls, address): ¶

Check if the current host has the the given IP address.

This is done by trying to bind the given address. We return True if we succeed or false if a socket.error is raised.

Parameters
address:str	IP address to be checked
Returns
bool	True if we own the address, False otherwise

@classmethod
def ValidateNetmask(cls, netmask): ¶

Validate a netmask suffix in CIDR notation.

Parameters
netmask:int	netmask suffix to validate
Returns
bool	True if valid, False otherwise

@staticmethod
def GetAddressFamily(address): ¶

Get the address family of the given address.

Parameters
address:str	ip address whose family will be returned
Returns
int	`socket.AF_INET` or `socket.AF_INET6`
Raises
`errors.GenericError`	for invalid addresses

@staticmethod
def GetAddressFamilyFromVersion(version): ¶

Convert an IP version to the corresponding IP address family.

Parameters
version:int	IP version, one of `constants.IP4_VERSION` or `constants.IP6_VERSION`
Returns
an int containing the IP address family, one of `socket.AF_INET` or `socket.AF_INET6`
Raises
`errors.ProgrammerError`	for unknown IP versions

@staticmethod
def GetClassFromIpFamily(family): ¶

Return the IPAddress subclass for the given IP family.

Parameters
family	IP family (one of `socket.AF_INET` or `socket.AF_INET6`
Returns
a subclass of `netutils.IPAddress`
Raises
`errors.ProgrammerError`	for unknowo IP versions

@staticmethod
def GetClassFromIpVersion(version): ¶

Return the IPAddress subclass for the given IP version.

Parameters
version:int	IP version, one of `constants.IP4_VERSION` or `constants.IP6_VERSION`
Returns
a subclass of `netutils.IPAddress`
Raises
`errors.ProgrammerError`	for unknowo IP versions

@staticmethod
def GetVersionFromAddressFamily(family): ¶

Convert an IP address family to the corresponding IP version.

Parameters
family:int	IP address family, one of socket.AF_INET or socket.AF_INET6
Returns
an int containing the IP version, one of `constants.IP4_VERSION` or `constants.IP6_VERSION`
Raises
`errors.ProgrammerError`	for unknown families

family = ¶

Undocumented

iplen: int = ¶

overridden in ganeti.netutils.IP4Address, ganeti.netutils.IP6Address

Undocumented

loopback_cidr = ¶

overridden in ganeti.netutils.IP4Address, ganeti.netutils.IP6Address

Undocumented

@staticmethod
def _GetIPIntFromString(address): ¶

overridden in ganeti.netutils.IP4Address, ganeti.netutils.IP6Address

Abstract method to please pylint.