Files
podman/docs/source/markdown/podman-network-inspect.1.md
Paul Holzinger 85e8fbf7f3 Wire network interface into libpod
Make use of the new network interface in libpod.

This commit contains several breaking changes:
- podman network create only outputs the new network name and not file
  path.
- podman network ls shows the network driver instead of the cni version
  and plugins.
- podman network inspect outputs the new network struct and not the cni
  conflist.
- The bindings and libpod api endpoints have been changed to use the new
  network structure.

The container network status is stored in a new field in the state. The
status should be received with the new `c.getNetworkStatus`. This will
migrate the old status to the new format. Therefore old containers should
contine to work correctly in all cases even when network connect/
disconnect is used.

New features:
- podman network reload keeps the ip and mac for more than one network.
- podman container restore keeps the ip and mac for more than one
  network.
- The network create compat endpoint can now use more than one ipam
  config.

The man pages and the swagger doc are updated to reflect the latest
changes.

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2021-09-15 20:00:20 +02:00

2.5 KiB

% podman-network-inspect(1)

NAME

podman-network-inspect - Displays the raw CNI network configuration for one or more networks

SYNOPSIS

podman network inspect [options] network [network ...]

DESCRIPTION

Display the raw (JSON format) network configuration.

OPTIONS

--format, -f=format

Pretty-print networks to JSON or using a Go template.

Placeholder Description
.ID Network ID
.Name Network name
.Driver Network driver
.Labels Network labels
.Options Network options
.IPAMOptions Network ipam options
.Created Timestamp when the network was created
.Internal Network is internal (boolean)
.IPv6Enabled Network has ipv6 subnet (boolean)
.DNSEnabled Network has dns enabled (boolean)
.NetworkInterface Name of the network interface on the host
.Subnets List of subnets on this network

EXAMPLE

Inspect the default podman network.

$ podman network inspect podman
[
    {
        "name": "podman",
        "id": "2f259bab93aaaaa2542ba43ef33eb990d0999ee1b9924b557b7be53c0b7a1bb9",
        "driver": "bridge",
        "network_interface": "cni-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"
        }
    }
]

Show the subnet and gateway for a network.

$ podman network inspect podman --format "{{range .Subnets}}Subnet: {{.Subnet}} Gateway: {{.Gateway}}{{end}}"
Subnet: 10.88.0.0/16 Gateway: 10.88.0.1

SEE ALSO

podman(1), podman-network(1), podman-network-ls(1), podman-network-create(1)

HISTORY

August 2021, Updated with the new network format by Paul Holzinger pholzing@redhat.com

August 2019, Originally compiled by Brent Baude bbaude@redhat.com