/ 
API-Docker-0.004
/ API::Docker::Type::IPAMConfig

NAME

API::Docker::Type::IPAMConfig - One entry of IPAM.Config

VERSION

version 0.004

DESCRIPTION

Generated from the IPAMConfig definition of spec/v1.51.yaml, which the swagger leaves undescribed. Nothing in paths: reaches it either; it is one entry of IPAM.Config. Neither the definition nor any of its four fields carries a description, but "config" in API::Docker::Type::IPAM writes out the map form an entry takes: {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}. That is where the four sentences below come from.

subnet

Undocumented upstream. A CIDR block. Measured against Podman 5.8.4 (API 1.44), the default bridge network answers 10.88.0.0/16; the swagger's example is 172.20.0.0/16.

ip_range

Undocumented upstream. A CIDR block inside "subnet", 172.20.10.0/24 against a 172.20.0.0/16 subnet in the swagger's examples. Serialised as IPRange -- spelled out, because deriving it from the Perl name would produce IpRange.

gateway

Undocumented upstream. An IP address. Measured against Podman 5.8.4 (API 1.44), the default bridge network answers 10.88.0.1; the swagger's example is 172.20.10.11.

auxiliary_addresses

Undocumented upstream. A device name for each key and an IP address for each value, which is what "AuxAddress": <device_name:IP address> in "config" in API::Docker::Type::IPAM spells out. The keys are the caller's data and are never translated.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.