connection

dpsctl check connection Usage Guide

Perform BMC connection check on configured nodes.

Usage

dpsctl check connection

Flags

Includes global dpsctl options.

   --topology value                 (optional) topology name. If provided without --nodes, all nodes in that topology are checked.
   --nodes value [ --nodes value ]  (optional) comma separated names of nodes to perform check on. If provided, only these nodes are checked.
   --help, -h

Behavior

The dpsctl check connection command determines which nodes to ping based on the provided flags:

Node Selection Rules:

  1. If --nodes is provided: Only the specified nodes are checked
  2. If no --nodes but --topology is provided: All nodes in the specified topology are checked
  3. If neither --nodes nor --topology is provided: This is a no-op and will not return anything

Examples

Check all known devices (no flags provided)

$ dpsctl check connection
{
  "total_nodes": 4,
  "success_nodes": 4,
  "failure_nodes": []
}

Check all nodes in a specific topology

$ dpsctl check connection --topology my-topology
{
  "total_nodes": 4,
  "success_nodes": 4,
  "failure_nodes": []
}

Check specific nodes

$ dpsctl check connection --nodes node002,node003
{
  "total_nodes": 2,
  "success_nodes": 2,
  "failure_nodes": []
}

Check specific nodes (topology flag ignored when nodes are specified)

$ dpsctl check connection --topology my-topology --nodes node002,node003
{
  "total_nodes": 2,
  "success_nodes": 2,
  "failure_nodes": []
}

Check with connection failures

$ dpsctl check connection --nodes node004
{
  "total_nodes": 1,
  "success_nodes": 0,
  "failure_nodes": [
    {
      "node_name": "node004",
      "error_msg": "BMC connection timeout"
    }
  ]
}