This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Docker.

Summary

Settings for docker swarm init [OPTIONS]. Initialize a swarm

Assembly

Cake.Docker.dll

Namespace

Cake.Docker

Base Types

ToolSettings
AutoToolSettings

graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Docker/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["DockerSwarmInitSettings"] class Type type-node

Syntax

public sealed class DockerSwarmInitSettings : AutoToolSettings

Constructors

Name	Summary
DockerSwarmInitSettings()

Fields

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

Properties

Name	Value	Summary
AdvertiseAddr	string	--advertise-addr Advertised address (format: <ip\|interface>[:port])
Autolock	Nullable<bool>	--autolock default: false Enable manager autolocking (requiring an unlock key to start a stopped manager)
Availability	string	--availability default: active Availability of the node (active\|pause\|drain)
CertExpiry	string	--cert-expiry default: 9024time.Hour Validity period for node certificates (ns\|us\|ms\|s\|m\|h)
DataPathAddr	string	--data-path-addr Address or interface to use for data path traffic (format: <ip\|interface>)
DispatcherHeartbeat	string	--dispatcher-heartbeat default: 5*time.Second Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h)
ExternalCa	string	--external-ca Specifications of one or more certificate signing endpoints
ForceNewCluster	Nullable<bool>	--force-new-cluster default: false Force create a new cluster from current state
ListenAddr	string	--listen-addr Listen address (format: <ip\|interface>[:port])
MaxSnapshots	string	--max-snapshots
SnapshotInterval	string	--snapshot-interval
TaskHistoryLimit	Nullable<long>	--task-history-limit default: 5 Task history retention limit

Methods

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

Extension Methods

Name	Value	Summary
Dump<DockerSwarmInitSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<DockerSwarmInitSettings>(DockerSwarmInitSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DockerSwarmInitSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<DockerSwarmInitSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<DockerSwarmInitSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<DockerSwarmInitSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin