Provided by: podman_4.9.3+ds1-1ubuntu0.2_amd64 bug

NAME

       podman-network-create - Create a Podman network

SYNOPSIS

       podman network create  [options] [name]

DESCRIPTION

       Create  a  network  configuration for use with Podman. By default, Podman creates a bridge connection.  A
       Macvlan connection can be created with the -d macvlan option. A parent device for macvlan or  ipvlan  can
       be designated with the -o parent=<device> or --network-interface=<device> option.

       If no options are provided, Podman assigns a free subnet and name for the network.

       Upon completion of creating the network, Podman displays the name of the newly added network.

       NOTE:  The  support  for "pasta" as network name value is deprecated and will not be accepted in the next
       major Podman version 5.0, because it is used as a special network mode in  podman  run/create  --network.
       The  CNI  backend  is  also  deprecated and will also be removed in the next major Podman version 5.0, in
       preference of Netavark, see podman-network(1) on how to change the backend.

OPTIONS

   --disable-dns
       Disables the DNS plugin for this network which if  enabled,  can  perform  container  to  container  name
       resolution. It is only supported with the bridge driver, for other drivers it is always disabled.

   --dns=ip
       Set  network-scoped  DNS resolver/nameserver for containers in this network. If not set, the host servers
       from /etc/resolv.conf is used.  It can be overwritten on the container level with the  podman  run/create
       --dns option. This option can be specified multiple times to set more than one IP.

   --driver, -d=driver
       Driver to manage the network. Currently bridge, macvlan and ipvlan are supported. Defaults to bridge.  As
       rootless  the  macvlan  and  ipvlan driver have no access to the host network interfaces because rootless
       networking requires a separate network namespace.

       The netavark backend allows the use of so called netavark plugins, see the plugin-API.md documentation in
       netavark. The binary must be placed in a specified directory so podman can discover it, this list is  set
       in netavark_plugin_dirs in containers.conf(5) under the [network] section.

       The  name  of the plugin can then be used as driver to create a network for your plugin.  The list of all
       supported drivers and plugins can be seen with podman info --format {{.Plugins.Network}}.

       Note that the macvlan and ipvlan drivers do not support port forwarding. Support for port forwarding with
       a plugin depends on the implementation of the plugin.

   --gateway=ip
       Define a gateway for the subnet. To provide a gateway address,  a  subnet  option  is  required.  Can  be
       specified  multiple  times.   The  argument  order of the --subnet, --gateway and --ip-range options must
       match.

   --ignore
       Ignore the create request if a network with the same name  already  exists  instead  of  failing.   Note,
       trying  to  create  a  network  with  an  existing  name  and  different  parameters  does not change the
       configuration of the existing one.

   --interface-name=name
       This option maps the network_interface  option  in  the  network  config,  see  podman  network  inspect.
       Depending  on the driver, this can have different effects; for bridge, it uses the bridge interface name.
       For macvlan and ipvlan, it is the parent device on the host. It is the same as --opt parent=....

   --internal
       Restrict external access of this network when using a bridge network. Note when using the CNI backend DNS
       will be automatically disabled, see --disable-dns.

       When using the macvlan or ipvlan driver with this option no default route will be added to the container.
       Because it bypasses the host network stack no additional restrictions can be  set  by  podman  and  if  a
       privileged  container  is  run  it  can  set  a  default  route themselves. If this is a concern then the
       container connections should be blocked on your actual network gateway.

   --ip-range=range
       Allocate container IP from a range. The range must be a either a complete subnet in CIDR notation  or  be
       in  the <startIP>-<endIP> syntax which allows for a more flexible range compared to the CIDR subnet.  The
       ip-range option must be used with a subnet option. Can be specified multiple times.  The  argument  order
       of the --subnet, --gateway and --ip-range options must match.

   --ipam-driver=driver
       Set  the  ipam  driver  (IP Address Management Driver) for the network. When unset podman chooses an ipam
       driver automatically based on the network driver.

       Valid values are:

              • dhcp: IP addresses are assigned from a dhcp server on  the  network.  When  using  the  netavark
                backend  the  netavark-dhcp-proxy.socket must be enabled in order to start the dhcp-proxy when a
                container is started, for CNI use the cni-dhcp.socket unit instead.

              • host-local: IP addresses are assigned locally.

              • none: No ip addresses are assigned to the interfaces.

       View the driver in the podman network inspect output under the ipam_options field.

   --ipv6
       Enable IPv6 (Dual Stack) networking. If no subnets are given, it allocates an ipv4 and an ipv6 subnet.

   --label=label
       Set metadata for a network (e.g., --label mykey=value).

   --opt, -o=option
       Set driver specific options.

       All drivers accept the mtu, metric, no_default_route and options.

              • mtu: Sets the Maximum Transmission Unit (MTU) and takes an integer value.

              • metric Sets the Route Metric for the default route created in every  container  joined  to  this
                network. Accepts a positive integer value. Can only be used with the Netavark network backend.

              • no_default_route:  If  set  to  1, Podman will not automatically add a default route to subnets.
                Routes can still be added manually by creating a custom route using --route.

       Additionally the bridge driver supports the following options:

              • vlan: This option assign VLAN tag and enables vlan_filtering. Defaults to none.

              • isolate: This option isolates networks by blocking traffic between those that have  this  option
                enabled.

              • com.docker.network.bridge.name: This option assigns the given name to the created Linux Bridge

              • com.docker.network.driver.mtu:  Sets  the  Maximum  Transmission Unit (MTU) and takes an integer
                value.

              • vrf: This option assigns a VRF to the bridge interface. It accepts  the  name  of  the  VRF  and
                defaults to none. Can only be used with the Netavark network backend.

       The macvlan and ipvlan driver support the following options:

              • parent:  The  host device which is used for the macvlan interface. Defaults to the default route
                interface.

              • mode: This option sets the specified ip/macvlan mode on the interface.

                • Supported values for macvlan are bridge, private, vepa, passthru. Defaults to bridge.

                • Supported values for ipvlan are l2, l3, l3s. Defaults to l2.

       Additionally the macvlan driver supports the bclim option:

              • bclim: Set the threshold for broadcast queueing. Must be a 32 bit integer. Setting this value to
                -1 disables broadcast queueing altogether.

   --route=route
       A static route in the format <destination in CIDR  notation>,<gateway>,<route  metric  (optional)>.  This
       route  will be added to every container in this network. Only available with the netavark backend. It can
       be specified multiple times if more than one static route is desired.

   --subnet=subnet
       The subnet in CIDR notation. Can be specified multiple times to allocate more than one  subnet  for  this
       network.   The  argument  order  of  the  --subnet, --gateway and --ip-range options must match.  This is
       useful to set a static ipv4 and ipv6 subnet.

EXAMPLE

       Create a network with no options.

       $ podman network create
       podman2

       Create a network named newnet that uses 192.5.0.0/16 for its subnet.

       $ podman network create --subnet 192.5.0.0/16 newnet
       newnet

       Create an IPv6 network named newnetv6 with a subnet of 2001:db8::/64.

       $ podman network create --subnet 2001:db8::/64 --ipv6 newnetv6
       newnetv6

       Create a network named newnet that uses 192.168.33.0/24 and defines a gateway as 192.168.133.3.

       $ podman network create --subnet 192.168.33.0/24 --gateway 192.168.33.3 newnet
       newnet

       Create a network that uses a 192.168.55.0/24 subnet and has an  IP  address  range  of  192.168.55.129  -
       192.168.55.254.

       $ podman network create --subnet 192.168.55.0/24 --ip-range 192.168.55.128/25
       podman5

       Create a network with a static ipv4 and ipv6 subnet and set a gateway.

       $ podman network create --subnet 192.168.55.0/24 --gateway 192.168.55.3 --subnet fd52:2a5a:747e:3acd::/64 --gateway fd52:2a5a:747e:3acd::10
       podman4

       Create a network with a static subnet and a static route.

       $ podman network create --subnet 192.168.33.0/24 --route 10.1.0.0/24,192.168.33.10 newnet

       Create a network with a static subnet and a static route without a default route.

       $ podman network create --subnet 192.168.33.0/24 --route 10.1.0.0/24,192.168.33.10 --opt no_default_route=1 newnet

       Create a Macvlan based network using the host interface eth0. Macvlan networks can only be used as root.

       $ sudo podman network create -d macvlan -o parent=eth0 --subnet 192.5.0.0/16 newnet
       newnet

SEE ALSO

       podman(1), podman-network(1), podman-network-inspect(1), podman-network-ls(1), containers.conf(5)

HISTORY

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

       August 2019, Originally compiled by Brent Baude bbaude@redhat.commailto:bbaude@redhat.compodman-network-create(1)