Interface ClusterInfo

ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included. ClusterInfo

interface ClusterInfo {
    CreatedAt?: string;
    DataPathPort?: number;
    DefaultAddrPool?: string[];
    ID?: string;
    RootRotationInProgress?: boolean;
    Spec?: SwarmSpec;
    SubnetSize?: number;
    TLSInfo?: TLSInfo;
    UpdatedAt?: string;
    Version?: ObjectVersion;
}

Properties

CreatedAt? DataPathPort? DefaultAddrPool? ID? RootRotationInProgress? Spec? SubnetSize? TLSInfo? UpdatedAt? Version?

Properties

OptionalCreatedAt

CreatedAt?: string

Date and time at which the swarm was initialised in RFC 3339 format with nano-seconds.

OptionalDataPathPort

DataPathPort?: number

DataPathPort specifies the data path port number for data traffic. Acceptable port range is 1024 to 49151. If no port is set or is set to 0, the default port (4789) is used.

OptionalDefaultAddrPool

DefaultAddrPool?: string[]

Default Address Pool specifies default subnet pools for global scope networks.

OptionalID

ID?: string

The ID of the swarm.

OptionalRootRotationInProgress

RootRotationInProgress?: boolean

Whether there is currently a root CA rotation in progress for the swarm

OptionalSpec

Spec?: SwarmSpec

OptionalSubnetSize

SubnetSize?: number

SubnetSize specifies the subnet size of the networks created from the default subnet pool.

OptionalTLSInfo

TLSInfo?: TLSInfo

OptionalUpdatedAt

UpdatedAt?: string

Date and time at which the swarm was last updated in RFC 3339 format with nano-seconds.

OptionalVersion

Version?: ObjectVersion

Settings

Member Visibility

On This Page

Properties