How-To GuidesPeer Management
Update Peer Metadata
How to update a peer's name and other metadata
How to Update Peer Metadata
This guide shows you how to update a peer's metadata, such as its human-readable name.
Before You Start
Ensure you have:
- The peer ID of the peer you want to update
- Appropriate permissions (peers.write scope)
Steps
1. Find the Peer ID
List peers to find the ID:
arctic peers list2. Update the Peer
Update the peer's name:
arctic peers update PEER_ID --name "Production Server 1"3. Verify the Update
Confirm the change:
arctic peers get PEER_IDWhat Can Be Updated
Currently, the following peer metadata can be updated:
| Field | Description |
|---|---|
name | Human-readable name for the peer |
Other peer attributes (public key, peer ID, etc.) are immutable and cannot be changed.
Propagation
Peer name updates are local to the agent where you make the change. Other cluster members maintain their own names for peers. If you want consistent naming across the cluster, update the peer on each agent.
Troubleshooting
Peer Not Found
If the peer ID is not found:
- Verify the peer ID:
arctic peers list - Check you are connected to the correct agent
Permission Denied
If you receive an authorization error:
- Verify your credentials have the
urn:tillered:arctic:peers.writescope - Check that your token has not expired