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 join [OPTIONS] HOST:PORT. Join a swarm as a node and/or manager

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["DockerSwarmJoinSettings"] class Type type-node

Syntax

public sealed class DockerSwarmJoinSettings : AutoToolSettings

Constructors

Name	Summary
DockerSwarmJoinSettings()

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])
Availability	string	--availability default: active Availability of the node (active\|pause\|drain)
DataPathAddr	string	--data-path-addr Address or interface to use for data path traffic (format: <ip\|interface>)
ListenAddr	string	--listen-addr Listen address (format: <ip\|interface>[:port])
Token	string	--token Token for entry into the swarm

Methods

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

Extension Methods

Name	Value	Summary
Dump<DockerSwarmJoinSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<DockerSwarmJoinSettings>(DockerSwarmJoinSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DockerSwarmJoinSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<DockerSwarmJoinSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<DockerSwarmJoinSettings>(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<DockerSwarmJoinSettings>(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