diff options
Diffstat (limited to 'docs/source/markdown/podman-network-inspect.1.md')
| -rw-r--r-- | docs/source/markdown/podman-network-inspect.1.md | 76 |
1 files changed, 45 insertions, 31 deletions
diff --git a/docs/source/markdown/podman-network-inspect.1.md b/docs/source/markdown/podman-network-inspect.1.md index 56515d0c1..726f167e5 100644 --- a/docs/source/markdown/podman-network-inspect.1.md +++ b/docs/source/markdown/podman-network-inspect.1.md @@ -4,57 +4,71 @@ podman\-network\-inspect - Displays the raw CNI network configuration for one or more networks ## SYNOPSIS -**podman network inspect** [*options*] [*network* ...] +**podman network inspect** [*options*] *network* [*network* ...] ## DESCRIPTION Display the raw (JSON format) network configuration. ## OPTIONS -#### **--format**, **-f** +#### **--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 +Inspect the default podman network. ``` -# podman network inspect podman -[{ - "cniVersion": "0.3.0", - "name": "podman", - "plugins": [ - { - "type": "bridge", - "bridge": "cni0", - "isGateway": true, - "ipMasq": true, - "ipam": { - "type": "host-local", - "subnet": "10.88.1.0/24", - "routes": [ - { "dst": "0.0.0.0/0" } - ] - } - }, - { - "type": "portmap", - "capabilities": { - "portMappings": true +$ 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 '{{(index .plugins 0).ipam.ranges}}' -[[map[gateway:10.88.0.1 subnet:10.88.0.0/16]]] +$ 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(1)](podman.1.md)**, **[podman-network(1)](podman-network.1.md)**, **[podman-network-ls(1)](podman-network-ls.1.md)**, **[podman-network-create(1)](podman-network-create.1.md)** ## 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> |