Search or ask Docker

SwarmInfo

SwarmInfo schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Represents generic information about swarm.
Cluster

Schema: ClusterInfo

ControlAvailable

Type: boolean

All schema constraints and annotations
{
  "default": false,
  "example": true,
  "type": "boolean"
}
Error

Type: string

All schema constraints and annotations
{
  "default": "",
  "type": "string"
}
LocalNodeState

Schema: LocalNodeState

Managers

Type: integer

Total number of managers in the swarm.
All schema constraints and annotations
{
  "description": "Total number of managers in the swarm.",
  "example": 3,
  "type": "integer",
  "x-nullable": true
}
NodeAddr

Type: string

IP address at which this node can be reached by other nodes in the swarm.
All schema constraints and annotations
{
  "default": "",
  "description": "IP address at which this node can be reached by other nodes in the\nswarm.\n",
  "example": "10.0.0.46",
  "type": "string"
}
NodeID

Type: string

Unique identifier of for this node in the swarm.
All schema constraints and annotations
{
  "default": "",
  "description": "Unique identifier of for this node in the swarm.",
  "example": "k67qz4598weg5unwwffg6z1m1",
  "type": "string"
}
Nodes

Type: integer

Total number of nodes in the swarm.
All schema constraints and annotations
{
  "description": "Total number of nodes in the swarm.",
  "example": 4,
  "type": "integer",
  "x-nullable": true
}
RemoteManagers

Type: array

List of ID's and addresses of other managers in the swarm.
Array item

Schema: PeerNode

All schema constraints and annotations
{
  "description": "List of ID's and addresses of other managers in the swarm.\n",
  "example": [
    {
      "Addr": "10.0.0.158:2377",
      "NodeID": "71izy0goik036k48jg985xnds"
    },
    {
      "Addr": "10.0.0.159:2377",
      "NodeID": "79y6h1o4gv8n120drcprv5nmc"
    },
    {
      "Addr": "10.0.0.46:2377",
      "NodeID": "k67qz4598weg5unwwffg6z1m1"
    }
  ],
  "items": {
    "$ref": "#/components/schemas/PeerNode"
  },
  "type": "array",
  "x-nullable": true
}
All schema constraints and annotations
{
  "description": "Represents generic information about swarm.\n",
  "properties": {
    "Cluster": {
      "$ref": "#/components/schemas/ClusterInfo"
    },
    "ControlAvailable": {
      "default": false,
      "example": true,
      "type": "boolean"
    },
    "Error": {
      "default": "",
      "type": "string"
    },
    "LocalNodeState": {
      "$ref": "#/components/schemas/LocalNodeState"
    },
    "Managers": {
      "description": "Total number of managers in the swarm.",
      "example": 3,
      "type": "integer",
      "x-nullable": true
    },
    "NodeAddr": {
      "default": "",
      "description": "IP address at which this node can be reached by other nodes in the\nswarm.\n",
      "example": "10.0.0.46",
      "type": "string"
    },
    "NodeID": {
      "default": "",
      "description": "Unique identifier of for this node in the swarm.",
      "example": "k67qz4598weg5unwwffg6z1m1",
      "type": "string"
    },
    "Nodes": {
      "description": "Total number of nodes in the swarm.",
      "example": 4,
      "type": "integer",
      "x-nullable": true
    },
    "RemoteManagers": {
      "description": "List of ID's and addresses of other managers in the swarm.\n",
      "example": [
        {
          "Addr": "10.0.0.158:2377",
          "NodeID": "71izy0goik036k48jg985xnds"
        },
        {
          "Addr": "10.0.0.159:2377",
          "NodeID": "79y6h1o4gv8n120drcprv5nmc"
        },
        {
          "Addr": "10.0.0.46:2377",
          "NodeID": "k67qz4598weg5unwwffg6z1m1"
        }
      ],
      "items": {
        "$ref": "#/components/schemas/PeerNode"
      },
      "type": "array",
      "x-nullable": true
    }
  },
  "type": "object"
}