ipam¶

Classes to support Internet Protocol Address Management.

Provided for compatibility

class IPAMConfig(driver: str | None = 'host-local', pool_configs: list[IPAMPool] | None = None, options: Mapping[str, Any] | None = None)[source]¶

Bases: dict

Collect IP Address configuration.

Create IPAMConfig.

Parameters:

driver – Network driver to use with this network.
pool_configs – Network and endpoint information. Podman only supports one pool.
options – Options to provide to the Network driver.

clear() → None. Remove all items from D.¶

copy() → a shallow copy of D¶

classmethod fromkeys(iterable, value=None, /)¶: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)¶: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items¶

keys() → a set-like object providing a view on D's keys¶

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()¶

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)¶

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.¶: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values¶

class IPAMPool(subnet: str | None = None, iprange: str | None = None, gateway: str | None = None, aux_addresses: Mapping[str, str] | None = None)[source]¶

Bases: dict

Collect IP Network configuration.

Create IPAMPool.