Manage node labels
Assign user-defined labels to nodes in your InfluxDB Enterprise cluster. Node labels are user-defined key-value pairs assigned to nodes in your cluster that act as metadata for each node.
The tools used for viewing and managing node labels in your InfluxDB Enterprise cluster
are the influxd-ctl show command
and the influxd-ctl node-label command and subcommands.
- View node labels
- Add labels to a node
- Update node labels
- Delete node labels
- Programmatically access node labels
View node labels
Use the influxd-ctl show command
to view information about nodes in your InfluxDB Enterprise cluster, including
node labels.
influxd-ctl show
Add labels to a node
To add a label to a node in your InfluxDB Enterprise cluster, use the
influxd-ctl node-labels set command
and include the following flags:
- -nodeid: Node ID to add the labels to
- -labels: JSON object of label key-value pairs
influxd-ctl node-labels set -nodeid 4 -labels '{"az":"us-east","team":"amer"}'
Update node labels
To update node labels, use the
influxd-ctl node-labels set command
and include the following flags:
- -nodeid: Node ID to update the labels on
- -labels: JSON object of label key-value pairs to update
influxd-ctl node-labels set -nodeid 4 -labels '{"team":"emea"}'
Only label keys included in the -labels JSON object are updated.
All other node labels are not modified.
Delete node labels
To update node labels, use the
influxd-ctl node-labels set command
and include the following flags:
- -nodeid: Node ID to update the labels on
- -labels: JSON object of label key-value pairs to update
influxd-ctl node-labels delete -nodeid 4 -labels '["team"]'
Programmatically access node labels
Use the /show-cluster endpoint of meta node API to return a JSON object containing
information about your InfluxDB Enterprise cluster, including node labels.
GET meta-node-host:8191/show-cluster
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.