Appendix D. Heketi CLI Commands

This section provides a list of some of the useful heketi-cli commands:
  • heketi-cli topology info

    This command retreives information about the current Topology.

  • heketi-cli cluster list

    Lists the clusters managed by Heketi

    For example:
    # heketi-cli cluster list
    Clusters:
    9460bbea6f6b1e4d833ae803816122c6
  • heketi-cli cluster info <cluster_id>

    Retrieves the information about the cluster.

    For example:
    # heketi-cli cluster info 9460bbea6f6b1e4d833ae803816122c6
    Cluster id: 9460bbea6f6b1e4d833ae803816122c6
    Nodes:
    1030f9361cff8c6bfde7b9b079327c78
    30f2ab4d971da572b03cfe33a1ba525f
    f648e1ddc0b95f3069bd2e14c7e34475
    Volumes:
    142e0ec4a4c1d1cc082071329a0911c6
    638d0dc6b1c85f5eaf13bd5c7ed2ee2a
  • heketi-cli node info <node_id>

    Retrieves the information about the node.

    For example:
    # heketi-cli node info 1030f9361cff8c6bfde7b9b079327c78
    Node Id: 1030f9361cff8c6bfde7b9b079327c78
    State: online
    Cluster Id: 9460bbea6f6b1e4d833ae803816122c6
    Zone: 1
    Management Hostname: node1.example.com
    Storage Hostname: 10.70.41.202
    Devices:
    Id:69214867a4d32251aaf1dcd77cb7f359   Name:/dev/vdg            State:online    Size (GiB):4999    Used (GiB):253     Free (GiB):4746    
    Id:6cd437c304979ea004abc2c4da8bdaf4   Name:/dev/vde            State:online    Size (GiB):4999    Used (GiB):354     Free (GiB):4645    
    Id:d2e9fcd9da04999ddab11cab651e18d2   Name:/dev/vdf            State:online    Size (GiB):4999    Used (GiB):831     Free (GiB):4168
  • heketi-cli volume list

    Lists the volumes managed by Heketi

    For example:
    # heketi-cli volume list
    Id:142e0ec4a4c1d1cc082071329a0911c6    Cluster:9460bbea6f6b1e4d833ae803816122c6    Name:heketidbstorage
    Id:638d0dc6b1c85f5eaf13bd5c7ed2ee2a    Cluster:9460bbea6f6b1e4d833ae803816122c6    Name:scalevol-1
For more information, refer to the man page of the heketi-cli.
# heketi-cli --help
The command line program for Heketi.
Usage

  • heketi-cli [flags]
  • heketi-cli [command]
For example:
# export HEKETI_CLI_SERVER=http://localhost:8080
# heketi-cli volume list
The available commands are listed below:
  • cluster

    Heketi cluster management

  • device

    Heketi device management

  • setup-openshift-heketi-storage

    Setup OpenShift/Kubernetes persistent storage for Heketi

  • node

    Heketi Node Management

  • topology

    Heketi Topology Management

  • volume

    Heketi Volume Management