podman-build/docs/build/man/podman-network-inspect.1
2025-10-11 12:30:35 +09:00

102 lines
2.3 KiB
Groff

'\" t
.nh
.TH podman-network-inspect 1
.SH NAME
podman-network-inspect \- Display the network configuration for one or more networks
.SH SYNOPSIS
\fBpodman network inspect\fP [\fIoptions\fP] \fInetwork\fP [\fInetwork\fP ...]
.SH DESCRIPTION
Display the (JSON format) network configuration.
.SH OPTIONS
.SS \fB--format\fP, \fB-f\fP=\fIformat\fP
Pretty-print networks to JSON or using a Go template.
.TS
allbox;
l l
l l .
\fB\fBPlaceholder\fP\fP \fB\fBDescription\fP\fP
\&.Containers ... T{
Running containers on this network.
T}
\&.Created ... T{
Timestamp when the network was created
T}
\&.DNSEnabled T{
Network has dns enabled (boolean)
T}
\&.Driver Network driver
\&.ID Network ID
\&.Internal Network is internal (boolean)
\&.IPAMOptions ... Network ipam options
\&.IPv6Enabled T{
Network has ipv6 subnet (boolean)
T}
\&.Labels ... Network labels
\&.Name Network name
\&.Network ... Nested Network type
\&.NetworkDNSServers T{
Array of DNS servers used in this network
T}
\&.NetworkInterface T{
Name of the network interface on the host
T}
\&.Options ... Network options
\&.Routes T{
List of static routes for this network
T}
\&.Subnets T{
List of subnets on this network
T}
.TE
.SH EXAMPLE
Inspect the default podman network.
.EX
$ podman network inspect podman
[
{
"name": "podman",
"id": "2f259bab93aaaaa2542ba43ef33eb990d0999ee1b9924b557b7be53c0b7a1bb9",
"driver": "bridge",
"network_interface": "podman0",
"created": "2021-06-03T12:04:33.088567413+02:00",
"subnets": [
{
"subnet": "10.88.0.0/16",
"gateway": "10.88.0.1"
}
],
"ipv6_enabled": false,
"internal": false,
"dns_enabled": false,
"ipam_options": {
"driver": "host-local"
}
}
]
.EE
.PP
Show the subnet and gateway for a network.
.EX
$ podman network inspect podman --format "{{range .Subnets}}Subnet: {{.Subnet}} Gateway: {{.Gateway}}{{end}}"
Subnet: 10.88.0.0/16 Gateway: 10.88.0.1
.EE
.SH SEE ALSO
\fBpodman(1)\fP, \fBpodman-network(1)\fP, \fBpodman-network-ls(1)\fP, \fBpodman-network-create(1)\fP
.SH HISTORY
August 2021, Updated with the new network format by Paul Holzinger pholzing@redhat.com
\[la]mailto:pholzing@redhat.com\[ra]
.PP
August 2019, Originally compiled by Brent Baude bbaude@redhat.com
\[la]mailto:bbaude@redhat.com\[ra]