Octopus.DockerNetwork exported 2026-07-22 by Octopus Deploy belongs to ‘Docker’ category.
Create a Docker Network for use by Docker Containers.
Parameters
When this step is included in a project’s deployment process, the parameters below can be set.
Network Type
Octopus.Action.Docker.NetworkType
The type of Docker network to create.
Allowed values: bridge, other
Default: bridge
Custom Driver
Octopus.Action.Docker.NetworkCustomDriver
Use an installed third party or own custom network driver. Only applicable when Network Type is ‘other’.
Network Name
Octopus.Action.Docker.NetworkName
Optional network name. If not specified this will be randomly generated.
Subnets
Octopus.Action.Docker.NetworkSubnet
Subnet in CIDR format that represents a network segment. On a bridge network you can only specify a single subnet. Specified as a comma-separated list.
Example: 172.28.5.0/24
IP Range
Octopus.Action.Docker.NetworkIPRange
Allocate container ip from a sub-range. Specified as a comma-separated list in CIDR format.
Example: 172.28.5.0/24
Network Gateway
Octopus.Action.Docker.NetworkGateway
IPv4 or IPv6 gateway for the master subnet. By default the Docker engine will select one from inside a preferred pool. Specified as a comma-separated list.
Example: 172.28.5.1
Additional Arguments
Octopus.Action.Docker.Args
Additional arguments that will be passed to the docker network create command.
Step configuration using OCL
Example in Octopus Configuration Language (OCL):
step "create-docker-network" {
name = "Create Docker Network"
properties = {
Octopus.Action.TargetRoles = "docker-host"
}
action {
action_type = "Octopus.DockerNetwork"
properties = {
Octopus.Action.Docker.NetworkGateway = "172.28.0.1"
Octopus.Action.Docker.NetworkName = "my-app-network"
Octopus.Action.Docker.NetworkSubnet = "172.28.0.0/16"
Octopus.Action.Docker.NetworkType = "bridge"
Octopus.Action.RunOnServer = "false"
}
}
}Page updated on Wednesday, July 22, 2026