DockerNetworkCreateSettings Class

Summary

Settings for docker create [OPTIONS] NETWORK. Create a network
Assembly
Cake.Docker.dll
Namespace
Cake.Docker
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerNetworkCreateSettings"] class Type type-node

Syntax

public sealed class DockerNetworkCreateSettings : AutoToolSettings

Constructors

Fields

Name Constant Value Summary
SecretProperties
Values of these properties shouldn't be displayed in the output.
Inherited from AutoToolSettings

Properties

Name Value Summary
Attachable Nullable<bool>
--attachable default: false Enable manual container attachment
AuxAddress string[]
--aux-address Auxiliary IPv4 or IPv6 addresses used by Network driver
ConfigFrom string
--config-from The network from which copying the configuration
ConfigOnly Nullable<bool>
--config-only default: false Create a configuration only network
Driver string
--driver, -d default: bridge Driver to manage the Network
Gateway string[]
--gateway default: IPv4 or IPv6 Gateway for the master subnet
Ingress Nullable<bool>
--ingress default: false Create swarm routing-mesh network
Internal Nullable<bool>
--internal default: false Restrict external access to the network
IpamDriver string
--ipam-driver default: default IP Address Management Driver
IpamOpt string[]
--ipam-opt Set IPAM driver specific options
IpRange string[]
--ip-range default: Allocate container ip from a sub-range
Ipv6 Nullable<bool>
--ipv6 default: false Enable IPv6 networking
Label string[]
--label Set metadata on a network
Opt string[]
--opt, -o Set driver specific options
Scope string
--scope Control the network's scope
Subnet string[]
--subnet default: Subnet in CIDR format that represents a network segment

Methods

Name Value Summary
CollectSecretProperties() string[]
Collects secret properties.
Inherited from AutoToolSettings

Extension Methods

Name Value Summary
Dump<DockerNetworkCreateSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DockerNetworkCreateSettings>(DockerNetworkCreateSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DockerNetworkCreateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DockerNetworkCreateSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DockerNetworkCreateSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DockerNetworkCreateSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin