# MgmtServiceResource Resource

### DELETE /cm/service

Delete the Cloudera Management Services.

This method will fail if a CMS instance doesn't already exist.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiService (JSON) | ApiService The deleted CMS information.

### GET /cm/service

Retrieve information about the Cloudera Management Services.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiService (JSON) | Details about the management service.

### GET /cm/service

Retrieve information about the Cloudera Management Services.

Request Parameters
name | type | description | default
--- | --- | --- | ---
view | query |  | summary

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiService (JSON) | Details about the management service.

### PUT /cm/service

Setup the Cloudera Management Services.

Configure the CMS instance and create all the management roles. The provided configuration data can be used to set up host mappings for each role, and required configuration such as database connection information for specific roles.

Regardless of the list of roles provided in the input data, all management roles are created by this call. The input is used to override any default settings for the specific roles.

This method needs a valid CM license to be installed beforehand.

This method does not start any services or roles.

This method will fail if a CMS instance already exists.

Available role types:

- SERVICEMONITOR
- ACTIVITYMONITOR
- HOSTMONITOR
- REPORTSMANAGER
- EVENTSERVER
- ALERTPUBLISHER
- NAVIGATOR
- NAVIGATORMETASERVER

REPORTSMANAGER, NAVIGATOR and NAVIGATORMETASERVER are only available with Cloudera Manager Enterprise Edition.

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiService (JSON) | Role configuration overrides.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiService (JSON) | ApiService The CMS information.

### PUT /cm/service/autoAssignRoles

Automatically assign roles to hosts and create the roles for the Cloudera Management Service.

Assignments are done based on number of hosts in the deployment and hardware specifications. If no hosts are part of the deployment, an exception will be thrown preventing any role assignments. Existing roles will be taken into account and their assignments will be not be modified. The deployment should not have any clusters when calling this endpoint. If it does, an exception will be thrown preventing any role assignments.

Available since API v6.

### PUT /cm/service/autoConfigure

Automatically configures roles of the Cloudera Management Service.

Overwrites some existing configurations. Only default role config groups must exist before calling this endpoint. Other role config groups must not exist. If they do, an exception will be thrown preventing any configuration. Ignores any clusters (and their services and roles) colocated with the Cloudera Management Service. To avoid over-committing the heap on hosts, place the Cloudera Management Service roles on machines not used by any of the clusters.

Available since API v6.

### GET /cm/service/commands

List active Cloudera Management Services commands.

Request Parameters
name | type | description | default
--- | --- | --- | ---
view | query | The view of the data to materialize, either "summary" or "full". | summary

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommandList (JSON) | A list of active role commands.

### GET /cm/service/config

Retrieve the configuration of the Cloudera Management Services.

Request Parameters
name | type | description | default
--- | --- | --- | ---
view | query | The view of the data to materialize, either "summary" or "full". | summary

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiServiceConfig (JSON) | List with configured and available configuration options.

### PUT /cm/service/config

Update the Cloudera Management Services configuration.

If a value is set in the given configuration, it will be added to the service's configuration, replacing any existing entries. If a value is unset (its value is null), the existing configuration for the attribute will be erased, if any.

Attributes that are not listed in the input will maintain their current values in the configuration.

Request Parameters
name | type | description | default
--- | --- | --- | ---
message | query | Optional message describing the changes. | n/a

Request Body
media type | data type | description
--- | --- | ---
application/json | ApiServiceConfig (JSON) | Configuration changes.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiServiceConfig (JSON) | The new service configuration.

### GET /cm/service/roleTypes

List the supported role types for the Cloudera Management Services.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiRoleTypeList (JSON) | List of role types the service supports.

### POST /cm/service/commands/enterMaintenanceMode

Put Cloudera Management Service into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v18.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | Synchronous command result.

### POST /cm/service/commands/exitMaintenanceMode

Take Cloudera Management Service out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v18.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | Synchronous command result.

### POST /cm/service/commands/restart

Restart the Cloudera Management Services.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | A reference to the submitted command.

### POST /cm/service/commands/start

Start the Cloudera Management Services.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | A reference to the submitted command.

### POST /cm/service/commands/stop

Stop the Cloudera Management Services.

Response Body
media type | data type | description
--- | --- | ---
application/json | ApiCommand (JSON) | A reference to the submitted command.