/cm/peers

Mount Point: /api/v13/cm/peers

GET

Retrieves all configured Cloudera Manager peers.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

When accessed via API version before v11, only REPLICATION type peers will be returned.

Response Body

element: cmPeerList

List of Cloudera Manager peers.

POST

Create a new Cloudera Manager peer.

The remote server will be contacted so that a user can be created for use by the new peer. The username and password properties of the provided peer object should contain credentials of a valid admin user on the remote server. A timeout of 10 seconds is enforced when contacting the remote server.

It is recommended to run the remote server with TLS enabled, since creating and using peers involve transferring credentials over the network.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

Type field in ApiCmPeer is available since API v11. if not specified when making createPeer() call, 'REPLICATION' type peer will be created.

Request Body

element: cmPeer

Peer to create (see above).

Response Body

element: cmPeer

Information about the created peer.