Information about a Cloudera Manager peer instance.
The requirement and usage of username and password properties are dependent on the clouderaManagerCreatedUser flag.
When creating peers, if 'clouderaManagerCreatedUser' is true, the username/password should be the credentials of a user with administrator privileges on the remote Cloudera Manager. These credentials are not stored, they are used to connect to the peer and create a user in that peer. The newly created user is stored and used for communication with that peer. If 'clouderaManagerCreatedUser' is false, which is not applicable to REPLICATION peer type, the username/password to the remote Cloudera Manager are directly stored and used for all communications with that peer.
When updating peers, if 'clouderaManagerCreatedUser' is true and username/password are set, a new remote user will be created. If 'clouderaManagerCreatedUser' is false and username/password are set, the stored username/password will be updated.
If 'createUserWithAdminRole' is true and 'clouderaManagerCreatedUser' is true, the created internal user will also be granted admin role.
| name | data type | description |
|---|---|---|
| name | string | The name of the remote CM instance. Immutable during update. |
| type | ApiCmPeerType | The type of the remote CM instance. Immutable during update. Available since API v11. |
| url | string | The URL of the remote CM instance. Mutable during update. |
| username | string | When creating peers, if 'clouderaManagerCreatedUser' is true, this should be the remote admin username for creating a user in remote Cloudera Manager. The created remote user will then be stored in the local Cloudera Manager DB and used in later communication. If 'clouderaManagerCreatedUser' is false, which is not applicable to REPLICATION peer type, Cloudera Manager will store this username in the local DB directly and use it together with 'password' for communication. Mutable during update. When set during update, if 'clouderaManagerCreatedUser' is true, a new user in remote Cloudera Manager is created, the newly created remote user will be stored in the local DB. An attempt to delete the previously created remote user will be made; If 'clouderaManagerCreatedUser' is false, the username/password in the local DB will be updated. |
| password | string | When creating peers, if 'clouderaManagerCreatedUser' is true, this should be the remote admin password for creating a user in remote Cloudera Manager. The created remote user will then be stored in the local Cloudera Manager DB and used in later communication. If 'clouderaManagerCreatedUser' is false, which is not applicable to REPLICATION peer type, Cloudera Manager will store this password in the local DB directly and use it together with 'username' for communication. Mutable during update. When set during update, if 'clouderaManagerCreatedUser' is true, a new user in remote Cloudera Manager is created, the newly created remote user will be stored in the local DB. An attempt to delete the previously created remote user will be made; If 'clouderaManagerCreatedUser' is false, the username/password in the local DB will be updated. |
| clouderaManagerCreatedUser | boolean | If true, Cloudera Manager creates a remote user using the given username/password and stores the created user in local DB for use in later communication. Cloudera Manager will also try to delete the created remote user when deleting such peers. If false, Cloudera Manager will store the provided username/password in the local DB and use them in later communication. 'false' value on this field is not applicable to REPLICATION peer type. Available since API v11. Immutable during update. Should not be set when updating peers. |
| createUserWithAdminRole | boolean | If true and clouderaManagerCreatedUser is true, the created user will have admin role granted. If false and clouderaManagerCreatedUser is true, the created user will have user role. null means false. Available since API v44. Needs to be set during update if changing the URL. |
Example
{
"name" : "...",
"type" : "REPLICATION",
"url" : "...",
"username" : "...",
"password" : "...",
"clouderaManagerCreatedUser" : true,
"createUserWithAdminRole" : true
}