/clusters/{clusterName}/services/{serviceName}/commands/deployClientConfig

Mount Point: /api/v10/clusters/{clusterName}/services/{serviceName}/commands/deployClientConfig

POST

Deploy a service's client configuration.

The client configuration is deployed to the hosts where the given roles are running.

Added in v3: passing null for the role name list will deploy client configs to all known service roles. Added in v6: passing an empty role name list will deploy client configs to all known service roles.

In Cloudera Manager 5.3 and newer, client configurations are fully managed, meaning that the server maintains state about which client configurations should exist and be managed by alternatives, and the agents actively rectify their hosts with this state. Consequently, if this API call is made with a specific set of roles, Cloudera Manager will deactivate, from alternatives, any deployed client configs from any non-gateway roles that are not specified as arguments. Gateway roles are always preserved, and calling this API with an empty or null argument continues to deploy to all roles.

Parameters

name description type default
serviceName The service name. path
clusterName (no documentation provided) path

Request Body

element: roleNames

List of role names.

Response Body

element: command

Information about the submitted command.