NAME
API::Docker::Type::NetworkSettings - NetworkSettings exposes the network settings in the API
VERSION
version 0.004
DESCRIPTION
Generated from the NetworkSettings definition of spec/v1.51.yaml.
bridge
Name of the default bridge interface when dockerd's --bridge flag is set.
Deprecated: This field is only set when the daemon is started with the --bridge flag specified.
sandbox_id
SandboxID uniquely represents a container's network stack. Serialised as SandboxID -- spelled out, because deriving it from the Perl name would produce SandboxId.
hairpin_mode
Indicates if hairpin NAT should be enabled on the virtual interface.
Deprecated: This field is never set and will be removed in a future release.
link_local_ipv6_address
IPv6 unicast address using the link-local prefix.
Deprecated: This field is never set and will be removed in a future release. Serialised as LinkLocalIPv6Address -- spelled out, because deriving it from the Perl name would produce LinkLocalIpv6Address.
link_local_ipv6_prefix_len
Prefix length of the IPv6 unicast address.
Deprecated: This field is never set and will be removed in a future release. Serialised as LinkLocalIPv6PrefixLen -- spelled out, because deriving it from the Perl name would produce LinkLocalIpv6PrefixLen.
ports
PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format <port>/<protocol>, for example, 80/udp.
If a container's port is mapped for multiple protocols, separate entries are added to the mapping table. See API::Docker::Type::PortBinding. The keys are the caller's data and are never translated.
sandbox_key
SandboxKey is the full path of the netns handle.
secondary_ip_addresses
Deprecated: This field is never set and will be removed in a future release. See API::Docker::Type::Address. Serialised as SecondaryIPAddresses -- spelled out, because deriving it from the Perl name would produce SecondaryIpAddresses.
secondary_ipv6_addresses
Deprecated: This field is never set and will be removed in a future release. See API::Docker::Type::Address. Serialised as SecondaryIPv6Addresses -- spelled out, because deriving it from the Perl name would produce SecondaryIpv6Addresses.
endpoint_id
EndpointID uniquely represents a service endpoint in a Sandbox.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0. Serialised as EndpointID -- spelled out, because deriving it from the Perl name would produce EndpointId.
gateway
Gateway address for the default "bridge" network.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0.
global_ipv6_address
Global IPv6 address for the default "bridge" network.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0. Serialised as GlobalIPv6Address -- spelled out, because deriving it from the Perl name would produce GlobalIpv6Address.
global_ipv6_prefix_len
Mask length of the global IPv6 address.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0. Serialised as GlobalIPv6PrefixLen -- spelled out, because deriving it from the Perl name would produce GlobalIpv6PrefixLen.
ip_address
IPv4 address for the default "bridge" network.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0. Serialised as IPAddress -- spelled out, because deriving it from the Perl name would produce IpAddress.
ip_prefix_len
Mask length of the IPv4 address.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0. Serialised as IPPrefixLen -- spelled out, because deriving it from the Perl name would produce IpPrefixLen.
ipv6_gateway
IPv6 gateway address for this network.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0. Serialised as IPv6Gateway -- spelled out, because deriving it from the Perl name would produce Ipv6Gateway.
mac_address
MAC address for the container on the default "bridge" network.
> Deprecated: This field is only propagated when attached to the > default "bridge" network. Use the information from the "bridge" > network inside the Networks map instead, which contains the same > information. This field was deprecated in Docker 1.9 and is scheduled > to be removed in Docker 17.12.0.
networks
Information about all networks that the container is connected to. See API::Docker::Type::EndpointSettings. 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.