cm_client.ServicesResourceApi

All URIs are relative to /api/v57

add_tags

list[ApiEntityTag] add_tags(cluster_name, service_name, body=body)

Attach tags to the service.

Attach tags to the service. Tag names beginning with the prefix cldr (case insensitive) are reserved for internal use by Cloudera.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the service
body = [cm_client.ApiEntityTag()] # list[ApiEntityTag] | List of tags to add to the service (optional)

try:
    # Attach tags to the service.
    api_response = api_instance.add_tags(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->add_tags: %s\n" % e)

Parameters

Return type

list[ApiEntityTag]

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

collect_yarn_application_diagnostics

ApiCommand collect_yarn_application_diagnostics(cluster_name, service_name, body=body)

Collect the Diagnostics data for Yarn applications.

Collect the Diagnostics data for Yarn applications

Available since API v8.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the YARN service on which to run the command.
body = cm_client.ApiYarnApplicationDiagnosticsCollectionArgs() # ApiYarnApplicationDiagnosticsCollectionArgs | Arguments used for collecting diagnostics data for Yarn applications (optional)

try:
    # Collect the Diagnostics data for Yarn applications.
    api_response = api_instance.collect_yarn_application_diagnostics(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->collect_yarn_application_diagnostics: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

copy_hdfs_file

ApiCommand copy_hdfs_file(cluster_name, service_name, body=body, destination_path=destination_path, source_path=source_path)

Copies source HDFS file to destination cluster HDFS.

Copies source HDFS file to destination cluster HDFS

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The source HDFS service
body = cm_client.ApiServiceRef() # ApiServiceRef | ApiServiceRef for the destination (optional)
destination_path = 'destination_path_example' # str | HDFS full path at destination (optional)
source_path = 'source_path_example' # str | HDFS full path at source (optional)

try:
    # Copies source HDFS file to destination cluster HDFS.
    api_response = api_instance.copy_hdfs_file(cluster_name, service_name, body=body, destination_path=destination_path, source_path=source_path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->copy_hdfs_file: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_beeswax_warehouse_command

ApiCommand create_beeswax_warehouse_command(cluster_name, service_name)

Create the Beeswax role's Hive warehouse directory, on Hue services.

Create the Beeswax role's Hive warehouse directory, on Hue services.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Hue service name.

try:
    # Create the Beeswax role's Hive warehouse directory, on Hue services.
    api_response = api_instance.create_beeswax_warehouse_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_beeswax_warehouse_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_h_base_root_command

ApiCommand create_h_base_root_command(cluster_name, service_name)

Creates the root directory of an HBase service.

Creates the root directory of an HBase service.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HBase service name.

try:
    # Creates the root directory of an HBase service.
    api_response = api_instance.create_h_base_root_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_h_base_root_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_hdfs_file

str create_hdfs_file(cluster_name, service_name, body=body, overwrite=overwrite, path=path)

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name
body = 'body_example' # str | Content to be put in the file to be created (optional)
overwrite = false # bool | If true overwrite the file (optional) (default to false)
path = 'path_example' # str | full path to the HDFS file to be created (optional)

try:
    api_response = api_instance.create_hdfs_file(cluster_name, service_name, body=body, overwrite=overwrite, path=path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_hdfs_file: %s\n" % e)

Parameters

Return type

str

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_hive_user_dir_command

ApiCommand create_hive_user_dir_command(cluster_name, service_name)

Create the Hive user directory.

Create the Hive user directory

Available since API v4.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Hive service name.

try:
    # Create the Hive user directory.
    api_response = api_instance.create_hive_user_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_hive_user_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_hive_warehouse_command

ApiCommand create_hive_warehouse_command(cluster_name, service_name)

Create the Hive warehouse directory, on Hive services.

Create the Hive warehouse directory, on Hive services.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Hive service name.

try:
    # Create the Hive warehouse directory, on Hive services.
    api_response = api_instance.create_hive_warehouse_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_hive_warehouse_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_hive_warehouse_external_command

ApiCommand create_hive_warehouse_external_command(cluster_name, service_name, directory=directory)

Create the Hive warehouse external directory for Private Cloud.

Create the Hive warehouse external directory for Private Cloud.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Hive service name.
directory = 'directory_example' # str | Name of the warehouse external directory. (optional)

try:
    # Create the Hive warehouse external directory for Private Cloud.
    api_response = api_instance.create_hive_warehouse_external_command(cluster_name, service_name, directory=directory)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_hive_warehouse_external_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_impala_user_dir_command

ApiCommand create_impala_user_dir_command(cluster_name, service_name)

Create the Impala user directory.

Create the Impala user directory

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Impala service name.

try:
    # Create the Impala user directory.
    api_response = api_instance.create_impala_user_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_impala_user_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_oozie_db

ApiCommand create_oozie_db(cluster_name, service_name)

Creates the Oozie Database Schema in the configured database.

Creates the Oozie Database Schema in the configured database. This command does not create database. This command creates only tables required by Oozie. To create database, please refer to oozieCreateEmbeddedDatabase()

Available since API v2.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Oozie service on which to run the command.

try:
    # Creates the Oozie Database Schema in the configured database.
    api_response = api_instance.create_oozie_db(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_oozie_db: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_services

ApiServiceList create_services(cluster_name, body=body)

Creates a list of services.

Creates a list of services.

There are typically two service creation strategies:

1. The caller may choose to set up a new service piecemeal, by first creating the service itself (without any roles or configuration), and then create the roles, and then specify configuration.
2. Alternatively, the caller can pack all the information in one call, by fully specifying the fields in the com.cloudera.api.model.ApiService object, with
   • service config and role type config, and
   • role to host assignment.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
body = cm_client.ApiServiceList() # ApiServiceList | Details of the services to create. (optional)

try:
    # Creates a list of services.
    api_response = api_instance.create_services(cluster_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_services: %s\n" % e)

Parameters

Return type

ApiServiceList

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_solr_hdfs_home_dir_command

ApiCommand create_solr_hdfs_home_dir_command(cluster_name, service_name)

Creates the home directory of a Solr service in HDFS.

Creates the home directory of a Solr service in HDFS.

Available since API v4.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Solr service name.

try:
    # Creates the home directory of a Solr service in HDFS.
    api_response = api_instance.create_solr_hdfs_home_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_solr_hdfs_home_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_sqoop_user_dir_command

ApiCommand create_sqoop_user_dir_command(cluster_name, service_name)

Creates the user directory of a Sqoop service in HDFS.

Creates the user directory of a Sqoop service in HDFS.

Available since API v4.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Sqoop service name.

try:
    # Creates the user directory of a Sqoop service in HDFS.
    api_response = api_instance.create_sqoop_user_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_sqoop_user_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_yarn_cm_container_usage_input_dir_command

ApiCommand create_yarn_cm_container_usage_input_dir_command(cluster_name, service_name)

Creates the HDFS directory where YARN container usage metrics are stored by NodeManagers for CM to read and aggregate into app usage metrics.

Creates the HDFS directory where YARN container usage metrics are stored by NodeManagers for CM to read and aggregate into app usage metrics.

Available since API v13.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The YARN service name.

try:
    # Creates the HDFS directory where YARN container usage metrics are stored by NodeManagers for CM to read and aggregate into app usage metrics.
    api_response = api_instance.create_yarn_cm_container_usage_input_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_yarn_cm_container_usage_input_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_yarn_job_history_dir_command

ApiCommand create_yarn_job_history_dir_command(cluster_name, service_name)

Create the Yarn job history directory.

Create the Yarn job history directory

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The YARN service name.

try:
    # Create the Yarn job history directory.
    api_response = api_instance.create_yarn_job_history_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_yarn_job_history_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_yarn_node_manager_remote_app_log_dir_command

ApiCommand create_yarn_node_manager_remote_app_log_dir_command(cluster_name, service_name)

Create the Yarn NodeManager remote application log directory.

Create the Yarn NodeManager remote application log directory

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The YARN service name.

try:
    # Create the Yarn NodeManager remote application log directory.
    api_response = api_instance.create_yarn_node_manager_remote_app_log_dir_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->create_yarn_node_manager_remote_app_log_dir_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

decommission_command

ApiCommand decommission_command(cluster_name, service_name, body=body)

Decommission roles of a service.

Decommission roles of a service.

For HBase services, the list should contain names of RegionServers to decommission.

For HDFS services, the list should contain names of DataNodes to decommission.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HBase service name.
body = cm_client.ApiRoleNameList() # ApiRoleNameList | List of role names to decommision. (optional)

try:
    # Decommission roles of a service.
    api_response = api_instance.decommission_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->decommission_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_hdfs_path

DeleteHdfsPathResult delete_hdfs_path(cluster_name, service_name, path=path, recursive=recursive)

Deletes the file or directory, specified by the given path, on the given HDFS service.

Deletes the file or directory, specified by the given path, on the given HDFS service.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name
path = 'path_example' # str | path of the file or directory to be deleted (optional)
recursive = true # bool | If the path is a directory and this is set to true, then deletes the directory and its contents, otherwise the call will fail if the directory is not empty (optional)

try:
    # Deletes the file or directory, specified by the given path, on the given HDFS service.
    api_response = api_instance.delete_hdfs_path(cluster_name, service_name, path=path, recursive=recursive)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->delete_hdfs_path: %s\n" % e)

Parameters

Return type

DeleteHdfsPathResult

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_service

ApiService delete_service(cluster_name, service_name)

Deletes a service from the system.

Deletes a service from the system.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service to delete.

try:
    # Deletes a service from the system.
    api_response = api_instance.delete_service(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->delete_service: %s\n" % e)

Parameters

Return type

ApiService

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_tags

list[ApiEntityTag] delete_tags(cluster_name, service_name, body=body)

Remove the tags associated with the service.

Remove the tags associated with the service. Tag names beginning with the prefix cldr (case insensitive) are reserved for internal use by Cloudera.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the service to remove tags from
body = [cm_client.ApiEntityTag()] # list[ApiEntityTag] | List of tags to remove from the service (optional)

try:
    # Remove the tags associated with the service.
    api_response = api_instance.delete_tags(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->delete_tags: %s\n" % e)

Parameters

Return type

list[ApiEntityTag]

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deploy_client_config_command

ApiCommand deploy_client_config_command(cluster_name, service_name, body=body)

Deploy a service's client configuration.

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.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiRoleNameList() # ApiRoleNameList | List of role names. (optional)

try:
    # Deploy a service's client configuration.
    api_response = api_instance.deploy_client_config_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->deploy_client_config_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_catalog_statestore_ha_command

ApiCommand disable_catalog_statestore_ha_command(cluster_name, service_name, body=body)

Disable high availability (HA) for Catalog and Statestore service.

Disable high availability (HA) for Catalog and Statestore service.

This command only applies to CDH 7.1.9SP1+ Impala Catalog and Statestore services.

The command will keep exactly one Catalog and Statestore server on the specified host.

All services that depend on Impala will be restarted after disabling Catalog and Statestore HA.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | A String representing the Impala service name.
body = cm_client.ApiDisableCatalogStatestoreHaArguments() # ApiDisableCatalogStatestoreHaArguments | An instance of ApiDisableCatalogStatestoreHaArguments
representing the arguments to the command. (optional)

try:
    # Disable high availability (HA) for Catalog and Statestore service.
    api_response = api_instance.disable_catalog_statestore_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_catalog_statestore_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_jt_ha_command

ApiCommand disable_jt_ha_command(cluster_name, service_name, body=body)

Disable high availability (HA) for JobTracker.

Disable high availability (HA) for JobTracker. As part of disabling HA, any services that depend on the MapReduce service being modified will be stopped. The command arguments provide options to specify name of JobTracker that will be preserved. The Command will redeploy the client configurations for services of the cluster after HA has been disabled.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The MapReduce service name.
body = cm_client.ApiDisableJtHaArguments() # ApiDisableJtHaArguments | Arguments for the command. (optional)

try:
    # Disable high availability (HA) for JobTracker.
    api_response = api_instance.disable_jt_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_jt_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_llama_ha_command

ApiCommand disable_llama_ha_command(cluster_name, service_name, body=body)

Not Supported.

Not Supported. Llama was removed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
body = cm_client.ApiDisableLlamaHaArguments() # ApiDisableLlamaHaArguments |  (optional)

try:
    # Not Supported.
    api_response = api_instance.disable_llama_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_llama_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_llama_rm_command

ApiCommand disable_llama_rm_command(cluster_name, service_name)

Not Supported.

Not Supported. Llama was removed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 

try:
    # Not Supported.
    api_response = api_instance.disable_llama_rm_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_llama_rm_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_oozie_ha_command

ApiCommand disable_oozie_ha_command(cluster_name, service_name, body=body)

Disable high availability (HA) for Oozie.

Disable high availability (HA) for Oozie. As part of disabling HA, any services that depend on the Oozie service being modified will be stopped. The command arguments provide options to specify name of Oozie Server that will be preserved. After deleting, other Oozie servers, all the services that were stopped are restarted.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Oozie service name.
body = cm_client.ApiDisableOozieHaArguments() # ApiDisableOozieHaArguments | Arguments for the command. (optional)

try:
    # Disable high availability (HA) for Oozie.
    api_response = api_instance.disable_oozie_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_oozie_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_rm_ha_command

ApiCommand disable_rm_ha_command(cluster_name, service_name, body=body)

Disable high availability (HA) for ResourceManager.

Disable high availability (HA) for ResourceManager. As part of disabling HA, any services that depend on the YARN service being modified will be stopped. The command arguments provide options to specify name of ResourceManager that will be preserved. The command will redeploy the client configurations for services of the cluster after HA has been disabled.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The YARN service name.
body = cm_client.ApiDisableRmHaArguments() # ApiDisableRmHaArguments | Arguments for the command. (optional)

try:
    # Disable high availability (HA) for ResourceManager.
    api_response = api_instance.disable_rm_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_rm_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_sentry_ha_command

ApiCommand disable_sentry_ha_command(cluster_name, service_name, body=body)

Disable high availability (HA) for Sentry service.

Disable high availability (HA) for Sentry service.

This command only applies to CDH 5.13+ Sentry services.

The command will keep exactly one Sentry server, on the specified host, and update the ZooKeeper configs needed for Sentry.

All services that depend on HDFS will be restarted after enabling Sentry HA.

Note: Sentry doesn't support Rolling Restart.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | A String representing the Sentry service name.
body = cm_client.ApiDisableSentryHaArgs() # ApiDisableSentryHaArgs | An instance of ApiDisableSentryHaArgs
representing the arguments to the command. (optional)

try:
    # Disable high availability (HA) for Sentry service.
    api_response = api_instance.disable_sentry_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->disable_sentry_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_catalog_statestore_ha_command

ApiCommand enable_catalog_statestore_ha_command(cluster_name, service_name, body=body)

Enable high availability (HA) for Catalog and Statestore service.

Enable high availability (HA) for Catalog and Statestore service.

This command only applies to CDH 7.1.9SP1+ Impala Catalog and Statestore services.

The command will create a new Catalog and Statestore server on the specified host for Catalog and Statestore HA.

All services that depend on Impala will be restarted after enabling Catalog and Statestore HA.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | A String representing the Impala service name.
body = cm_client.ApiEnableCatalogStatestoreHaArguments() # ApiEnableCatalogStatestoreHaArguments | An instance of ApiEnableCatalogStatestoreHaArguments
representing the arguments to the command. (optional)

try:
    # Enable high availability (HA) for Catalog and Statestore service.
    api_response = api_instance.enable_catalog_statestore_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_catalog_statestore_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_jt_ha_command

ApiCommand enable_jt_ha_command(cluster_name, service_name, body=body)

Enable high availability (HA) for a JobTracker.

Enable high availability (HA) for a JobTracker.

This command only applies to CDH4 MapReduce services.

The command will create a new JobTracker on the specified host and then create an active/standby pair with the existing JobTracker. Autofailover will be enabled using ZooKeeper. A ZNode will be created for this purpose. Command arguments provide option to forcefully create this ZNode if one already exists. A node may already exists if JobTracker was previously enabled in HA mode but HA mode was disabled later on. The ZNode is not deleted when HA is disabled.

As part of enabling HA, any services that depends on the MapReduce service being modified will be stopped. Command will redeploy the client configurations for services of the cluster after HA has been enabled.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The MapReduce service name.
body = cm_client.ApiEnableJtHaArguments() # ApiEnableJtHaArguments | Arguments for the command. (optional)

try:
    # Enable high availability (HA) for a JobTracker.
    api_response = api_instance.enable_jt_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_jt_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_llama_ha_command

ApiCommand enable_llama_ha_command(cluster_name, service_name, body=body)

Not Supported.

Not Supported. Llama was removed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
body = cm_client.ApiEnableLlamaHaArguments() # ApiEnableLlamaHaArguments |  (optional)

try:
    # Not Supported.
    api_response = api_instance.enable_llama_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_llama_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_llama_rm_command

ApiCommand enable_llama_rm_command(cluster_name, service_name, body=body)

Not Supported.

Not Supported. Llama was removed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
body = cm_client.ApiEnableLlamaRmArguments() # ApiEnableLlamaRmArguments |  (optional)

try:
    # Not Supported.
    api_response = api_instance.enable_llama_rm_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_llama_rm_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_oozie_ha_command

ApiCommand enable_oozie_ha_command(cluster_name, service_name, body=body)

Enable high availability (HA) for Oozie service.

Enable high availability (HA) for Oozie service.

This command only applies to CDH5+ Oozie services.

The command will create new Oozie Servers on the specified hosts and set the ZooKeeper and Load Balancer configs needed for Oozie HA.

As part of enabling HA, any services that depends on the Oozie service being modified will be stopped and restarted after enabling Oozie HA.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Oozie service name.
body = cm_client.ApiEnableOozieHaArguments() # ApiEnableOozieHaArguments | Arguments for the command. (optional)

try:
    # Enable high availability (HA) for Oozie service.
    api_response = api_instance.enable_oozie_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_oozie_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_rm_ha_command

ApiCommand enable_rm_ha_command(cluster_name, service_name, body=body)

Enable high availability (HA) for a YARN ResourceManager.

Enable high availability (HA) for a YARN ResourceManager.

This command only applies to CDH5+ YARN services.

The command will create a new ResourceManager on the specified host and then create an active/standby pair with the existing ResourceManager. Autofailover will be enabled using ZooKeeper.

As part of enabling HA, any services that depends on the YARN service being modified will be stopped. Command will redeploy the client configurations for services of the cluster after HA has been enabled.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The YARN service name.
body = cm_client.ApiEnableRmHaArguments() # ApiEnableRmHaArguments | Arguments for the command. (optional)

try:
    # Enable high availability (HA) for a YARN ResourceManager.
    api_response = api_instance.enable_rm_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_rm_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_sentry_ha_command

ApiCommand enable_sentry_ha_command(cluster_name, service_name, body=body)

Enable high availability (HA) for Sentry service.

Enable high availability (HA) for Sentry service.

This command only applies to CDH 5.13+ Sentry services.

The command will create a new Sentry server on the specified host and set the ZooKeeper configs needed for Sentry HA.

As part of enabling HA, all services that depend on HDFS will be restarted after enabling Sentry HA.

Note: Sentry doesn't support Rolling Restart.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | A String representing the Sentry service name.
body = cm_client.ApiEnableSentryHaArgs() # ApiEnableSentryHaArgs | An instance of ApiEnableSentryHaArgs
representing the arguments to the command. (optional)

try:
    # Enable high availability (HA) for Sentry service.
    api_response = api_instance.enable_sentry_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enable_sentry_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enter_maintenance_mode

ApiCommand enter_maintenance_mode(cluster_name, service_name)

Put the service into maintenance mode.

Put the service into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Put the service into maintenance mode.
    api_response = api_instance.enter_maintenance_mode(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->enter_maintenance_mode: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

exit_maintenance_mode

ApiCommand exit_maintenance_mode(cluster_name, service_name)

Take the service out of maintenance mode.

Take the service out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Take the service out of maintenance mode.
    api_response = api_instance.exit_maintenance_mode(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->exit_maintenance_mode: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

export_sentry_permissions_command

ApiCommand export_sentry_permissions_command(cluster_name, service_name)

Export Sentry Permissions.

Export Sentry Permissions.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Export Sentry Permissions.
    api_response = api_instance.export_sentry_permissions_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->export_sentry_permissions_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

first_run

ApiCommand first_run(cluster_name, service_name)

Prepare and start a service.

Prepare and start a service.

Perform all the steps needed to prepare the service and start it.

Available since API v7.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the cluster.

try:
    # Prepare and start a service.
    api_response = api_instance.first_run(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->first_run: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_client_config

str get_client_config(cluster_name, service_name)

Download a zip-compressed archive of the client configuration, of a specific service.

Download a zip-compressed archive of the client configuration, of a specific service. This resource does not require any authentication.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Download a zip-compressed archive of the client configuration, of a specific service.
    api_response = api_instance.get_client_config(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_client_config: %s\n" % e)

Parameters

Return type

str

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_hdfs_usage_report

ApiHdfsUsageReport get_hdfs_usage_report(cluster_name, service_name, aggregation=aggregation, _from=_from, nameservice=nameservice, to=to)

Fetch the HDFS usage report.

Fetch the HDFS usage report. For the requested time range, at the specified aggregation intervals, the report shows HDFS disk usages per user.

This call supports returning JSON or CSV, as determined by the "Accept" header of application/json or text/csv.

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

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
aggregation = 'daily' # str | The (optional) aggregation period for the data. Supports \"hourly\", \"daily\" (default) and \"weekly\". (optional) (default to daily)
_from = '_from_example' # str | The (optional) start time of the report in ISO 8601 format ( defaults to 24 hours before \"to\" time). (optional)
nameservice = 'nameservice_example' # str | The (optional) HDFS nameservice. Required for HA setup. (optional)
to = 'now' # str | The (optional) end time of the report in ISO 8601 format ( defaults to now). (optional) (default to now)

try:
    # Fetch the HDFS usage report.
    api_response = api_instance.get_hdfs_usage_report(cluster_name, service_name, aggregation=aggregation, _from=_from, nameservice=nameservice, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_hdfs_usage_report: %s\n" % e)

Parameters

Return type

ApiHdfsUsageReport

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: text/csv, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_iceberg_replication_access_status

ApiIcebergReplicationAccessStatus get_iceberg_replication_access_status(cluster_name, service_name, hms_warehouse_dir=hms_warehouse_dir, path=path, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)

Retrieves the access status for the given path.

Retrieves the access status for the given path.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the ICEBERG_REPLICATION service.
hms_warehouse_dir = 'hms_warehouse_dir_example' # str | The hmsWarehouseDir whose status is required. (optional)
path = 'path_example' # str | The cloudPath whose status is required in conjunction with hmsWarehouseDir. (optional)
source_cluster = 'source_cluster_example' # str | The name of the cluster on remote. (optional)
source_peer = 'source_peer_example' # str | The name of the peer. (optional)
source_service = 'source_service_example' # str | The name of the ICEBERG_REPLICATION service on remote. (optional)

try:
    # Retrieves the access status for the given path.
    api_response = api_instance.get_iceberg_replication_access_status(cluster_name, service_name, hms_warehouse_dir=hms_warehouse_dir, path=path, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_iceberg_replication_access_status: %s\n" % e)

Parameters

Return type

ApiIcebergReplicationAccessStatus

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_impala_utilization

ApiImpalaUtilization get_impala_utilization(cluster_name, service_name, days_of_week=days_of_week, end_hour_of_day=end_hour_of_day, _from=_from, start_hour_of_day=start_hour_of_day, tenant_type=tenant_type, to=to)

Provides the resource utilization of the Impala service as well as the resource utilization per tenant.

Provides the resource utilization of the Impala service as well as the resource utilization per tenant. Only available with Cloudera Manager Enterprise Edition.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | service name
days_of_week = ['days_of_week_example'] # list[str] | The days of the week for which the user wants to report utilization. Days is a list of number between 1 to 7, where 1 corresponds to Mon. and 7 corresponds to Sun. All 7 days are included if this is not specified. (optional)
end_hour_of_day = 23 # int | The end hour of a day for which the user wants to report utilization. The hour is a number between [0-23]. Default value is 23 if this is not specified. (optional) (default to 23)
_from = '_from_example' # str | Start of the time range to report utilization in ISO 8601 format. (optional)
start_hour_of_day = 0 # int | The start hour of a day for which the user wants to report utilization. The hour is a number between [0-23]. Default value is 0 if this is not specified. (optional) (default to 0)
tenant_type = 'POOL' # str | The type of the tenant (POOL or USER). (optional) (default to POOL)
to = 'now' # str | End of the the time range to report utilization in ISO 8601 format (defaults to now). (optional) (default to now)

try:
    # Provides the resource utilization of the Impala service as well as the resource utilization per tenant.
    api_response = api_instance.get_impala_utilization(cluster_name, service_name, days_of_week=days_of_week, end_hour_of_day=end_hour_of_day, _from=_from, start_hour_of_day=start_hour_of_day, tenant_type=tenant_type, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_impala_utilization: %s\n" % e)

Parameters

Return type

ApiImpalaUtilization

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_metrics

ApiMetricList get_metrics(cluster_name, service_name, _from=_from, metrics=metrics, to=to, view=view)

Fetch metric readings for a particular service.

Fetch metric readings for a particular service.

By default, this call will look up all metrics available for the service. If only specific metrics are desired, use the metrics parameter.

By default, the returned results correspond to a 5 minute window based on the provided end time (which defaults to the current server time). The from and to parameters can be used to control the window being queried. A maximum window of 3 hours is enforced.

When requesting a "full" view, aside from the extended properties of the returned metric data, the collection will also contain information about all metrics available for the service, even if no readings are available in the requested window.

HDFS services that have more than one nameservice will not expose any metrics. Instead, the nameservices should be queried separately.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service.
_from = '_from_example' # str | Start of the period to query. (optional)
metrics = ['metrics_example'] # list[str] | Filter for which metrics to query. (optional)
to = 'now' # str | End of the period to query. (optional) (default to now)
view = 'summary' # str | The view of the data to materialize, either \"summary\" or \"full\". (optional) (default to summary)

try:
    # Fetch metric readings for a particular service.
    api_response = api_instance.get_metrics(cluster_name, service_name, _from=_from, metrics=metrics, to=to, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_metrics: %s\n" % e)

Parameters

Return type

ApiMetricList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_mr_usage_report

ApiMrUsageReport get_mr_usage_report(cluster_name, service_name, aggregation=aggregation, _from=_from, to=to)

Fetch the MR usage report.

Fetch the MR usage report. For the requested time range, at the specified aggregation intervals, the report shows job CPU usages (and other metrics) per user.

This call supports returning JSON or CSV, as determined by the "Accept" header of application/json or text/csv.

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

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The MR service name.
aggregation = 'daily' # str | The (optional) aggregation period for the data. Supports \"hourly\", \"daily\" (default) and \"weekly\". (optional) (default to daily)
_from = '_from_example' # str | The (optional) start time of the report in ISO 8601 format (defaults to 24 hours before \"to\" time). (optional)
to = 'now' # str | The (optional) end time of the report in ISO 8601 format (defaults to now). (optional) (default to now)

try:
    # Fetch the MR usage report.
    api_response = api_instance.get_mr_usage_report(cluster_name, service_name, aggregation=aggregation, _from=_from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_mr_usage_report: %s\n" % e)

Parameters

Return type

ApiMrUsageReport

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: text/csv, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_policies_from_ranger

ApiRangerPolicyList get_policies_from_ranger(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)

Collects information about the policies defined in the local Ranger service.

Collects information about the policies defined in the local Ranger service.

Optionally if sourcePeer, sourceCluster, sourceUser are provided, then it will call the same API endpoint on that given source CM peer, and merges the result of the local (ApiRangerPolicyList#getPolicies()) and remote (ApiRangerPolicyList#getPolicies()) Ranger policies.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | the name of the local Ranger service.
source_cluster = 'source_cluster_example' # str | optional: the source CM cluster name. (optional)
source_peer = 'source_peer_example' # str | optional: the source CM peer name. (optional)
source_service = 'source_service_example' # str | optional: the Ranger service name on the source CM. (optional)

try:
    # Collects information about the policies defined in the local Ranger service.
    api_response = api_instance.get_policies_from_ranger(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_policies_from_ranger: %s\n" % e)

Parameters

Return type

ApiRangerPolicyList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_services_from_ranger

ApiRangerServiceList get_services_from_ranger(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)

Collects information about the services defined in the local Ranger service.

Collects information about the services defined in the local Ranger service.

Optionally if sourcePeer, sourceCluster, sourceService are provided, then it will call the same API endpoint on that given source CM peer, and merges the result of the local (ApiRangerServiceList#getServices()) and remote (ApiRangerServiceList#getRemoteServices()) Ranger services.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | the name of the local Ranger service.
source_cluster = 'source_cluster_example' # str | optional: the source CM cluster name. (optional)
source_peer = 'source_peer_example' # str | optional: the source CM peer name. (optional)
source_service = 'source_service_example' # str | optional: the Ranger service name on the source CM. (optional)

try:
    # Collects information about the services defined in the local Ranger service.
    api_response = api_instance.get_services_from_ranger(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_services_from_ranger: %s\n" % e)

Parameters

Return type

ApiRangerServiceList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_users_from_ranger

ApiRangerUserList get_users_from_ranger(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)

Collects information about the users defined in the local Ranger service.

Collects information about the users defined in the local Ranger service.

Optionally if sourcePeer, sourceCluster, sourceUser are provided, then it will call the same API endpoint on that given source CM peer, and merges the result of the local (ApiRangerUserList#getUsers()) and remote (ApiRangerUserList#getRemoteUsers()) Ranger users.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | the name of the local Ranger service.
source_cluster = 'source_cluster_example' # str | optional: the source CM cluster name. (optional)
source_peer = 'source_peer_example' # str | optional: the source CM peer name. (optional)
source_service = 'source_service_example' # str | optional: the Ranger service name on the source CM. (optional)

try:
    # Collects information about the users defined in the local Ranger service.
    api_response = api_instance.get_users_from_ranger(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_users_from_ranger: %s\n" % e)

Parameters

Return type

ApiRangerUserList

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_yarn_utilization

ApiYarnUtilization get_yarn_utilization(cluster_name, service_name, days_of_week=days_of_week, end_hour_of_day=end_hour_of_day, _from=_from, start_hour_of_day=start_hour_of_day, tenant_type=tenant_type, to=to)

Provides the resource utilization of the yarn service as well as the resource utilization per tenant.

Provides the resource utilization of the yarn service as well as the resource utilization per tenant. Only available with Cloudera Manager Enterprise Edition.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | service name
days_of_week = ['days_of_week_example'] # list[str] | The days of the week for which the user wants to report utilization. Days is a list of number between 1 to 7, where 1 corresponds to Mon. and 7 corresponds to Sun. All 7 days are included if this is not specified. (optional)
end_hour_of_day = 23 # int | The end hour of a day for which the user wants to report utilization. The hour is a number between [0-23]. Default value is 23 if this is not specified. (optional) (default to 23)
_from = '_from_example' # str | Start of the time range to report utilization in ISO 8601 format. (optional)
start_hour_of_day = 0 # int | The start hour of a day for which the user wants to report utilization. The hour is a number between [0-23]. Default value is 0 if this is not specified. (optional) (default to 0)
tenant_type = 'POOL' # str | The type of the tenant (POOL or USER). (optional) (default to POOL)
to = 'now' # str | End of the the time range to report utilization in ISO 8601 format (defaults to now). (optional) (default to now)

try:
    # Provides the resource utilization of the yarn service as well as the resource utilization per tenant.
    api_response = api_instance.get_yarn_utilization(cluster_name, service_name, days_of_week=days_of_week, end_hour_of_day=end_hour_of_day, _from=_from, start_hour_of_day=start_hour_of_day, tenant_type=tenant_type, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->get_yarn_utilization: %s\n" % e)

Parameters

Return type

ApiYarnUtilization

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_create_user_directory

ApiCommand hbase_replication_create_user_directory(cluster_name, service_name)

Create the HBase user directory (usually /user/hbase).

Create the HBase user directory (usually /user/hbase).

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name

try:
    # Create the HBase user directory (usually /user/hbase).
    api_response = api_instance.hbase_replication_create_user_directory(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_create_user_directory: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_automatic

ApiCommand hbase_replication_first_time_setup_automatic(cluster_name, service_name, body=body, force=force)

Starts an automatic HBase replication first time setup.

Starts an automatic HBase replication first time setup. After doing some configuration (see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)), it restarts both the source and target clusters.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiHBaseReplicationSetupCommandArgs() # ApiHBaseReplicationSetupCommandArgs | Replication setup parameters such as
the source peer, source service, passphrase for the keystore, and
optionally the RestartType
for both source and target (default is rolling restart) (optional)
force = false # bool | If true, perform setup even if already setup. (Default false) (optional) (default to false)

try:
    # Starts an automatic HBase replication first time setup.
    api_response = api_instance.hbase_replication_first_time_setup_automatic(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_automatic: %s\n" % e)

Parameters

the source peer, source service, passphrase for the keystore, and
optionally the RestartType
for both source and target (default is rolling restart) | [optional]
force | bool| If true, perform setup even if already setup. (Default false) | [optional] [default to false]

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_clean_and_reset

ApiCommand hbase_replication_first_time_setup_clean_and_reset(cluster_name, service_name, body=body)

Cleans and resets the HBase replication first time setup on the given source and target:.

Cleans and resets the HBase replication first time setup on the given source and target:

• clears the HBase replication auxiliary info and deletes the JCEKS files
• Optionally restarts HBase services
• Resets the HBase replication first time setup status

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiHBaseReplicationSetupCleanAndResetArgs() # ApiHBaseReplicationSetupCleanAndResetArgs | contains the source peer, source cluster, source service, and
the restart type of source and target HBase services.
Also, if user wants to reset the HBase replication first time setup
status on the source, then the cmPeerNameOnRemote field should be provided:
The peer name of the local CM in the given source CM peer (optional)

try:
    # Cleans and resets the HBase replication first time setup on the given source and target:.
    api_response = api_instance.hbase_replication_first_time_setup_clean_and_reset(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_clean_and_reset: %s\n" % e)

Parameters

the restart type of source and target HBase services.
Also, if user wants to reset the HBase replication first time setup
status on the source, then the cmPeerNameOnRemote field should be provided:
The peer name of the local CM in the given source CM peer | [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_for_already_paired_clusters

ApiCommand hbase_replication_first_time_setup_for_already_paired_clusters(cluster_name, service_name, body=body, force=force)

Starts an HBase replication first time setup for the source and target.

Starts an HBase replication first time setup for the source and target.

Before using this API endpoint, it's assumed that the source and target (local) HBase services already have the HBase replication first time setup executed but with different peers. It starts a command, that checks if the necessary configurations are in place on both source and target (see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)). If everything matches, then it sets the setup status to READY.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local (target) HBase service name
body = cm_client.ApiServiceRef() # ApiServiceRef | contains the source peer, source cluster, source HBase service name (optional)
force = false # bool | If true, perform setup even if already setup. (Default false) (optional) (default to false)

try:
    # Starts an HBase replication first time setup for the source and target.
    api_response = api_instance.hbase_replication_first_time_setup_for_already_paired_clusters(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_for_already_paired_clusters: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_for_source_only

ApiCommand hbase_replication_first_time_setup_for_source_only(cluster_name, service_name, body=body, force=force)

Starts an HBase replication first time setup for the source only.

Starts an HBase replication first time setup for the source only.

Before using this API endpoint, it's assumed that the target (local) HBase service already has HBase replication first time setup executed with another peer's HBase. It starts a command, that does some configuration only on the source (see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)), then restarts source HBase service if needed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local (target) HBase service name
body = cm_client.ApiHBaseReplicationSetupOneClusterOnlyCmdArgs() # ApiHBaseReplicationSetupOneClusterOnlyCmdArgs | Replication setup parameters such as
the source peer, source cluster, source service, HBase replication user,
and optionally the RestartType for the source HBase service.
If RestartType is:
<ul>
<li>
<b>provided</b>, then restarts source HBase service accordingly.
This is equivalent to the automatic first time setup:
#hbaseReplicationFirstTimeSetupAutomatic(String, boolean, ApiHBaseReplicationSetupCommandArgs)
</li>
<li>
<b>not provided</b>, then the source HBase service must be restarted manually.
This is equivalent to the manual first time setup:
#hbaseReplicationFirstTimeSetupManual(String, boolean, ApiHBaseReplicationSetupCommandArgs).
Similarly, after the source HBase service has been restarted,
the first time setup can be finished by calling:
#hbaseReplicationFirstTimeSetupManualContinue(String, ApiServiceRef)
</li>
</ul> (optional)
force = false # bool | If true, perform setup even if already setup. (Default false) (optional) (default to false)

try:
    # Starts an HBase replication first time setup for the source only.
    api_response = api_instance.hbase_replication_first_time_setup_for_source_only(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_for_source_only: %s\n" % e)

Parameters

the source peer, source cluster, source service, HBase replication user,
and optionally the RestartType for the source HBase service.
If RestartType is:

• 
  provided, then restarts source HBase service accordingly.
  This is equivalent to the automatic first time setup:
  #hbaseReplicationFirstTimeSetupAutomatic(String, boolean, ApiHBaseReplicationSetupCommandArgs)

• not provided, then the source HBase service must be restarted manually. This is equivalent to the manual first time setup: #hbaseReplicationFirstTimeSetupManual(String, boolean, ApiHBaseReplicationSetupCommandArgs). Similarly, after the source HBase service has been restarted, the first time setup can be finished by calling: #hbaseReplicationFirstTimeSetupManualContinue(String, ApiServiceRef)

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_for_target_only

ApiCommand hbase_replication_first_time_setup_for_target_only(cluster_name, service_name, body=body, force=force)

Starts an HBase replication first time setup for the target only.

Starts an HBase replication first time setup for the target only.

Before using this API endpoint, it's assumed that the given source HBase service, given by ApiHBaseReplicationSetupOneClusterOnlyCmdArgs, already has HBase replication first time setup executed with another peer's HBase. It starts a command, that does some configuration only on the target (see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)), then restarts target HBase service.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiHBaseReplicationSetupOneClusterOnlyCmdArgs() # ApiHBaseReplicationSetupOneClusterOnlyCmdArgs | Replication setup parameters such as
the source peer, source cluster, source service, HBase replication user,
and optionally the RestartType for the local HBase service
(default is rolling restart) (optional)
force = false # bool | If true, perform setup even if already setup. (Default false) (optional) (default to false)

try:
    # Starts an HBase replication first time setup for the target only.
    api_response = api_instance.hbase_replication_first_time_setup_for_target_only(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_for_target_only: %s\n" % e)

Parameters

the source peer, source cluster, source service, HBase replication user,
and optionally the RestartType for the local HBase service
(default is rolling restart) | [optional]
force | bool| If true, perform setup even if already setup. (Default false) | [optional] [default to false]

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_force_ready

hbase_replication_first_time_setup_force_ready(cluster_name, service_name, body=body)

Force sets the HBase replication first time setup status to be READY for the given source and target.

Force sets the HBase replication first time setup status to be READY for the given source and target. Note that after this operation, the pending HBase replication policies, which have the waitForHBaseReplicationSetup flag set to true, will NOT be completed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiServiceRef() # ApiServiceRef | contains the source peer, source cluster, source sourceService (optional)

try:
    # Force sets the HBase replication first time setup status to be READY for the given source and target.
    api_instance.hbase_replication_first_time_setup_force_ready(cluster_name, service_name, body=body)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_force_ready: %s\n" % e)

Parameters

Return type

void (empty response body)

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_manual

ApiCommand hbase_replication_first_time_setup_manual(cluster_name, service_name, body=body, force=force)

Starts a manual HBase replication first time setup.

Starts a manual HBase replication first time setup. After doing some configuration (see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)), it restarts the target cluster only. Source cluster has to be restarted manually, after which the #hbaseReplicationFirstTimeSetupManualContinue(String, ApiServiceRef) API endpoint should be called to finish the HBase replication first time setup.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiHBaseReplicationSetupCommandArgs() # ApiHBaseReplicationSetupCommandArgs | Replication setup parameters such as
the source peer, source service, passphrase for the keystore, and
optionally the RestartType
for the target (default is rolling restart) (optional)
force = false # bool | If true, perform setup even if already setup. (Default false) (optional) (default to false)

try:
    # Starts a manual HBase replication first time setup.
    api_response = api_instance.hbase_replication_first_time_setup_manual(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_manual: %s\n" % e)

Parameters

the source peer, source service, passphrase for the keystore, and
optionally the RestartType
for the target (default is rolling restart) | [optional]
force | bool| If true, perform setup even if already setup. (Default false) | [optional] [default to false]

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_manual_continue

ApiCommand hbase_replication_first_time_setup_manual_continue(cluster_name, service_name, body=body)

Should be called after #hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs) to finish the manual HBase replication first time setup.

Should be called after #hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs) to finish the manual HBase replication first time setup.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiServiceRef() # ApiServiceRef | contains the source peer, source cluster, source service (optional)

try:
    # Should be called after #hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs) to finish the manual HBase replication first time setup.
    api_response = api_instance.hbase_replication_first_time_setup_manual_continue(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_manual_continue: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_reset

hbase_replication_first_time_setup_reset(cluster_name, service_name, body=body)

Resets/removes the HBase replication first time setup status for the given source and target.

Resets/removes the HBase replication first time setup status for the given source and target.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
body = cm_client.ApiServiceRef() # ApiServiceRef | contains the source peer, source cluster, source sourceService (optional)

try:
    # Resets/removes the HBase replication first time setup status for the given source and target.
    api_instance.hbase_replication_first_time_setup_reset(cluster_name, service_name, body=body)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_reset: %s\n" % e)

Parameters

Return type

void (empty response body)

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_first_time_setup_status

ApiHBaseReplicationSetupStatus hbase_replication_first_time_setup_status(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The local HBase service name
source_cluster = 'source_cluster_example' # str | The source cluster's name (optional)
source_peer = 'source_peer_example' # str | The source peer's name (optional)
source_service = 'source_service_example' # str | The source service's name (optional)

try:
    api_response = api_instance.hbase_replication_first_time_setup_status(cluster_name, service_name, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_first_time_setup_status: %s\n" % e)

Parameters

Return type

ApiHBaseReplicationSetupStatus

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_setup

ApiCommand hbase_replication_setup(cluster_name, service_name, body=body, force=force)

Perform one time setup for HBase replication.

Perform one time setup for HBase replication. Generate the a keystore to HDFS for use by replication and transfer the keystore to HDFS on the the peer.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBaseReplicationSetupCommandArgs() # ApiHBaseReplicationSetupCommandArgs |  (optional)
force = false # bool | If true, perform setup even if already setup. (Default false) (optional) (default to false)

try:
    # Perform one time setup for HBase replication.
    api_response = api_instance.hbase_replication_setup(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_setup: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_replication_setup_admin

ApiCommand hbase_replication_setup_admin(cluster_name, service_name, cm_peer_definition=cm_peer_definition, op=op, path=path, user=user)

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
cm_peer_definition = 'cm_peer_definition_example' # str |  (optional)
op = 'op_example' # str |  (optional)
path = 'path_example' # str |  (optional)
user = 'user_example' # str |  (optional)

try:
    api_response = api_instance.hbase_replication_setup_admin(cluster_name, service_name, cm_peer_definition=cm_peer_definition, op=op, path=path, user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_replication_setup_admin: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_shell_command

ApiCommand hbase_shell_command(cluster_name, service_name, body=body)

Execute a hbase shell command.

Execute a hbase shell command

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HBase service name
body = cm_client.ApiHBaseShellCommand() # ApiHBaseShellCommand | hbase shell command to be executed (optional)

try:
    # Execute a hbase shell command.
    api_response = api_instance.hbase_shell_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_shell_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hbase_upgrade_command

ApiCommand hbase_upgrade_command(cluster_name, service_name)

Upgrade HBase data in HDFS and ZooKeeper as part of upgrade from CDH4 to CDH5.

Upgrade HBase data in HDFS and ZooKeeper as part of upgrade from CDH4 to CDH5.

This is required in order to run HBase after upgrade.

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HBase service name.

try:
    # Upgrade HBase data in HDFS and ZooKeeper as part of upgrade from CDH4 to CDH5.
    api_response = api_instance.hbase_upgrade_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hbase_upgrade_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_add_sbnnto_ns_command

ApiCommand hdfs_add_sbnnto_ns_command(cluster_name, service_name, body=body)

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | 
body = cm_client.ApiAddSBNNToNSArguments() # ApiAddSBNNToNSArguments |  (optional)

try:
    api_response = api_instance.hdfs_add_sbnnto_ns_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_add_sbnnto_ns_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_create_tmp_dir

ApiCommand hdfs_create_tmp_dir(cluster_name, service_name)

Creates a tmp directory on the HDFS filesystem.

Creates a tmp directory on the HDFS filesystem.

Available since API v2.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the HDFS service on which to run the command.

try:
    # Creates a tmp directory on the HDFS filesystem.
    api_response = api_instance.hdfs_create_tmp_dir(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_create_tmp_dir: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_disable_auto_failover_command

ApiCommand hdfs_disable_auto_failover_command(cluster_name, service_name, body=body)

Disable auto-failover for a highly available HDFS nameservice.

Disable auto-failover for a highly available HDFS nameservice.

The command will modify the nameservice's NameNodes configuration to disable automatic failover, and delete the existing failover controllers.

The ZooKeeper dependency of the service will not be removed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = 'body_example' # str | The nameservice name. (optional)

try:
    # Disable auto-failover for a highly available HDFS nameservice.
    api_response = api_instance.hdfs_disable_auto_failover_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_disable_auto_failover_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: text/plain, application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_disable_ha_command

ApiCommand hdfs_disable_ha_command(cluster_name, service_name, body=body)

Disable high availability (HA) for an HDFS NameNode.

Disable high availability (HA) for an HDFS NameNode.

The NameNode to be kept must be running before HA can be disabled.

As part of disabling HA, any services that depend on the HDFS service being modified will be stopped. The command arguments provide options to re-start these services and to re-deploy the client configurations for services of the cluster after HA has been disabled.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiHdfsDisableHaArguments() # ApiHdfsDisableHaArguments | Arguments for the command. (optional)

try:
    # Disable high availability (HA) for an HDFS NameNode.
    api_response = api_instance.hdfs_disable_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_disable_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_disable_nn_ha_command

ApiCommand hdfs_disable_nn_ha_command(cluster_name, service_name, body=body)

Disable High Availability (HA) with Automatic Failover for an HDFS NameNode.

Disable High Availability (HA) with Automatic Failover for an HDFS NameNode.

As part of disabling HA, any services that depend on the HDFS service being modified will be stopped. The command will delete the Standby NameNode associated with the specified NameNode. Any FailoverControllers associated with the NameNode's nameservice are also deleted. A SecondaryNameNode is created on the host specified by the arugments.

If no nameservices uses Quorum Journal after HA is disabled for the specified nameservice, then all JournalNodes are also deleted.

Then, HDFS service is restarted and all services that were stopped are started again afterwards. Finally, client configs for HDFS and its depedents will be re-deployed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiDisableNnHaArguments() # ApiDisableNnHaArguments | Arguments for the command. (optional)

try:
    # Disable High Availability (HA) with Automatic Failover for an HDFS NameNode.
    api_response = api_instance.hdfs_disable_nn_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_disable_nn_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_enable_auto_failover_command

ApiCommand hdfs_enable_auto_failover_command(cluster_name, service_name, body=body)

Enable auto-failover for an HDFS nameservice.

Enable auto-failover for an HDFS nameservice.

This command requires that the nameservice exists, and HA has been configured for that nameservice.

The command will create the needed failover controllers, perform the needed initialization and configuration, and will start the new roles. The existing NameNodes which are part of the nameservice will be re-started in the process.

This process may require changing the service's configuration, to add a dependency on the provided ZooKeeper service. This will be done if such a dependency has not been configured yet, and will cause roles that are not affected by this command to show an "outdated configuration" status.

If a ZooKeeper dependency has already been set up by some other means, it does not need to be provided in the command arguments.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiHdfsFailoverArguments() # ApiHdfsFailoverArguments | Arguments for the command. (optional)

try:
    # Enable auto-failover for an HDFS nameservice.
    api_response = api_instance.hdfs_enable_auto_failover_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_enable_auto_failover_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_enable_ha_command

ApiCommand hdfs_enable_ha_command(cluster_name, service_name, body=body)

Enable high availability (HA) for an HDFS NameNode.

Enable high availability (HA) for an HDFS NameNode.

The command will set up the given "active" and "stand-by" NameNodes as an HA pair. Both nodes need to already exist.

If there is a SecondaryNameNode associated with either given NameNode instance, it will be deleted.

Note that while the shared edits path may be different for both nodes, they need to point to the same underlying storage (e.g., an NFS share).

As part of enabling HA, any services that depend on the HDFS service being modified will be stopped. The command arguments provide options to re-start these services and to re-deploy the client configurations for services of the cluster after HA has been enabled.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiHdfsHaArguments() # ApiHdfsHaArguments | Arguments for the command. (optional)

try:
    # Enable high availability (HA) for an HDFS NameNode.
    api_response = api_instance.hdfs_enable_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_enable_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_enable_nn_ha_command

ApiCommand hdfs_enable_nn_ha_command(cluster_name, service_name, body=body)

Enable High Availability (HA) with Automatic Failover for an HDFS NameNode.

Enable High Availability (HA) with Automatic Failover for an HDFS NameNode.

The command will create a Standby NameNode for the given nameservice and create FailoverControllers for both Active and Standby NameNodes. The SecondaryNameNode associated with the Active NameNode will be deleted.

The command will also create JournalNodes needed for HDFS HA if they do not already exist.

As part of enabling HA, any services that depend on the HDFS service being modified will be stopped. They will be restarted after HA has been enabled. Finally, client configs for HDFS and its depedents will be re-deployed.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiEnableNnHaArguments() # ApiEnableNnHaArguments | Arguments for the command. (optional)

try:
    # Enable High Availability (HA) with Automatic Failover for an HDFS NameNode.
    api_response = api_instance.hdfs_enable_nn_ha_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_enable_nn_ha_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_failover_command

ApiCommand hdfs_failover_command(cluster_name, service_name, body=body, force=force)

Initiate a failover in an HDFS HA NameNode pair.

Initiate a failover in an HDFS HA NameNode pair.

The arguments should contain the names of the two NameNodes in the HA pair. The first one should be the currently active NameNode, the second one the NameNode to be made active.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiRoleNameList() # ApiRoleNameList | Names of the NameNodes in the HA pair. (optional)
force = false # bool | Whether to force failover. (optional) (default to false)

try:
    # Initiate a failover in an HDFS HA NameNode pair.
    api_response = api_instance.hdfs_failover_command(cluster_name, service_name, body=body, force=force)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_failover_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_finalize_rolling_upgrade

ApiCommand hdfs_finalize_rolling_upgrade(cluster_name, service_name)

Finalizes the rolling upgrade for HDFS by updating the NameNode metadata permanently to the next version.

Finalizes the rolling upgrade for HDFS by updating the NameNode metadata permanently to the next version. Should be done after doing a rolling upgrade to a CDH version >= 5.2.0.

Available since API v8.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.

try:
    # Finalizes the rolling upgrade for HDFS by updating the NameNode metadata permanently to the next version.
    api_response = api_instance.hdfs_finalize_rolling_upgrade(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_finalize_rolling_upgrade: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_roll_edits_command

ApiCommand hdfs_roll_edits_command(cluster_name, service_name, body=body)

Roll the edits of an HDFS NameNode or Nameservice.

Roll the edits of an HDFS NameNode or Nameservice.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.
body = cm_client.ApiRollEditsArgs() # ApiRollEditsArgs | Arguments to the Roll Edits command. (optional)

try:
    # Roll the edits of an HDFS NameNode or Nameservice.
    api_response = api_instance.hdfs_roll_edits_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_roll_edits_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hdfs_upgrade_metadata_command

ApiCommand hdfs_upgrade_metadata_command(cluster_name, service_name)

Upgrade HDFS Metadata as part of a major version upgrade.

Upgrade HDFS Metadata as part of a major version upgrade.

When doing a major version upgrade for HDFS, it is necessary to start HDFS in a special mode where it will do any necessary upgrades of stored metadata. Trying to start HDFS normally will result in an error message and the NameNode(s) failing to start.

The metadata upgrade must eventually be finalized, using the hdfsFinalizeMetadataUpgrade command on the NameNode.

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The HDFS service name.

try:
    # Upgrade HDFS Metadata as part of a major version upgrade.
    api_response = api_instance.hdfs_upgrade_metadata_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hdfs_upgrade_metadata_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hive_create_metastore_database_command

ApiCommand hive_create_metastore_database_command(cluster_name, service_name)

Create the Hive Metastore Database.

Create the Hive Metastore Database. Only works with embedded postgresql database.

This command is to be run whenever a new user and database needs to be created in the embedded postgresql database for a Hive service. This command should usually be followed by a call to hiveCreateMetastoreDatabaseTables.

Available since API v4.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Hive service on which to run the command.

try:
    # Create the Hive Metastore Database.
    api_response = api_instance.hive_create_metastore_database_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hive_create_metastore_database_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hive_create_metastore_database_tables_command

ApiCommand hive_create_metastore_database_tables_command(cluster_name, service_name)

Create the Hive Metastore Database tables.

Create the Hive Metastore Database tables.

This command is to be run whenever a new database has been specified. Will do nothing if tables already exist. Will not perform an upgrade. Only Available when all Hive Metastore Servers are stopped.

Available since API v3.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Hive service on which to run the command.

try:
    # Create the Hive Metastore Database tables.
    api_response = api_instance.hive_create_metastore_database_tables_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hive_create_metastore_database_tables_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hive_update_metastore_namenodes_command

ApiCommand hive_update_metastore_namenodes_command(cluster_name, service_name)

Update Hive Metastore to point to a NameNode's Nameservice name instead of hostname.

Update Hive Metastore to point to a NameNode's Nameservice name instead of hostname.

Back up the Hive Metastore Database before running this command.

This command is to be run after enabling HDFS High Availability. Only available when all Hive Metastore Servers are stopped.

Available since API v4.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Hive service on which to run the command.

try:
    # Update Hive Metastore to point to a NameNode's Nameservice name instead of hostname.
    api_response = api_instance.hive_update_metastore_namenodes_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hive_update_metastore_namenodes_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hive_upgrade_metastore_command

ApiCommand hive_upgrade_metastore_command(cluster_name, service_name)

Upgrade Hive Metastore as part of a major version upgrade.

Upgrade Hive Metastore as part of a major version upgrade.

When doing a major version upgrade for Hive, it is necessary to upgrade data in the metastore database.

Available since API v6.

Example

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Hive service name.

try:
    # Upgrade Hive Metastore as part of a major version upgrade.
    api_response = api_instance.hive_upgrade_metastore_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hive_upgrade_metastore_command: %s\n" % e)

Parameters

Return type

ApiCommand

Authorization

basic

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hive_validate_metastore_schema_command

ApiCommand hive_validate_metastore_schema_command(cluster_name, service_name)

Validate the Hive Metastore Schema.

Validate the Hive Metastore Schema.

This command checks the Hive metastore schema for any errors and corruptions. This command is to be run on two instances:

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Hive service on which to run the command.

try:
    # Validate the Hive Metastore Schema.
    api_response = api_instance.hive_validate_metastore_schema_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hive_validate_metastore_schema_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service

try:
    # Runs Hue's dumpdata command.
    api_response = api_instance.hue_dump_db_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hue_dump_db_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service

try:
    # Runs Hue's loaddata command.
    api_response = api_instance.hue_load_db_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hue_load_db_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service

try:
    # Runs Hue's syncdb command.
    api_response = api_instance.hue_sync_db_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->hue_sync_db_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the ICEBERG_REPLICATION service.
hms_warehouse_dir = 'hms_warehouse_dir_example' # str | The HMS warehouseDir path to test access. (optional)
path = 'path_example' # str | The cloudPath to test access. (optional)
source_cluster = 'source_cluster_example' # str | The name of the cluster on remote. (optional)
source_peer = 'source_peer_example' # str | The name of the peer. (optional)
source_service = 'source_service_example' # str | The name of the ICEBERG_REPLICATION service on remote. (optional)

try:
    # Executes IcebergReplicationTestAccess command for the given path.
    api_response = api_instance.iceberg_replication_test_access(cluster_name, service_name, hms_warehouse_dir=hms_warehouse_dir, path=path, source_cluster=source_cluster, source_peer=source_peer, source_service=source_service)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->iceberg_replication_test_access: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Impala service on which to run the command.

try:
    # .
    api_response = api_instance.impala_create_catalog_database_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->impala_create_catalog_database_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Impala service on which to run the command.

try:
    # .
    api_response = api_instance.impala_create_catalog_database_tables_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->impala_create_catalog_database_tables_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Yarn service on which to run the command.

try:
    # Import MapReduce configuration into Yarn, overwriting Yarn configuration.
    api_response = api_instance.import_mr_configs_into_yarn(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->import_mr_configs_into_yarn: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Solr service name.

try:
    # Initializes the Solr service in Zookeeper.
    api_response = api_instance.init_solr_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->init_solr_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the YARN service on which to run the command.

try:
    # Creates an HDFS directory to hold the MapReduce2 framework JARs (if necessary), and uploads the framework JARs to it.
    api_response = api_instance.install_mr_framework_jars(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->install_mr_framework_jars: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Oozie service on which to run the command.

try:
    # Creates directory for Oozie user in HDFS and installs the ShareLib in it.
    api_response = api_instance.install_oozie_share_lib(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->install_oozie_share_lib: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | A String representing the KeyStore Indexer service name.

try:
    # Migrates the HBase Indexer policy-based permissions to Sentry, by invoking the SentryConfigToolIndexer.
    api_response = api_instance.ks_migrate_to_sentry(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->ks_migrate_to_sentry: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service to which the role belongs.
command_name = 'command_name_example' # str | the command name, unique for the command class HdfsCreateSnapshotCommand#COMMAND_NAME (optional)
view = 'summary' # str | The view of the data to materialize, either \"summary\" or \"full\". (optional) (default to summary)

try:
    # List active service commands.
    api_response = api_instance.list_active_commands(cluster_name, service_name, command_name=command_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->list_active_commands: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service to modify.

try:
    # List the supported role types for a service.
    api_response = api_instance.list_role_types(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->list_role_types: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Lists all the commands (for CSD based services only) that can be executed by name on the provided service.
    api_response = api_instance.list_service_commands(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->list_service_commands: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiRoleNameList() # ApiRoleNameList | List of role names to offline. (optional)
timeout = 56 # int | Offline timeout in seconds. Offlined roles will automatically transition from offline state to normal state after timeout. Specify as null to get the default timeout (4 hours). (optional)

try:
    # Offline roles of a service.
    api_response = api_instance.offline_command(cluster_name, service_name, body=body, timeout=timeout)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->offline_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the Oozie service on which to run the command.

try:
    # Create the Oozie Server Database.
    api_response = api_instance.oozie_create_embedded_database_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->oozie_create_embedded_database_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service

try:
    # Dump the Oozie Server Database.
    api_response = api_instance.oozie_dump_database_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->oozie_dump_database_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service

try:
    # Load the Oozie Server Database from dump.
    api_response = api_instance.oozie_load_database_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->oozie_load_database_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The Oozie service name.

try:
    # Upgrade Oozie Database schema as part of a major version upgrade.
    api_response = api_instance.oozie_upgrade_db_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->oozie_upgrade_db_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
view = 'full' # str | DataView to materialize. Defaults to 'full'. (optional) (default to full)

try:
    # Retrieves details information about a service.
    api_response = api_instance.read_service(cluster_name, service_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->read_service: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service to query.
view = 'summary' # str | The view of the data to materialize, either \"summary\" or \"full\". (optional) (default to summary)

try:
    # Retrieves the configuration of a specific service.
    api_response = api_instance.read_service_config(cluster_name, service_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->read_service_config: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
view = 'summary' # str |  (optional) (default to summary)

try:
    # Lists all services registered in the cluster.
    api_response = api_instance.read_services(cluster_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->read_services: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The name of the service
limit = 10 # int | Number of tags (optional) (default to 10)
offset = 0 # int | Index of the first tag to retrieve (optional) (default to 0)

try:
    # Returns the tags associated with this service.
    api_response = api_instance.read_tags(cluster_name, service_name, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->read_tags: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the service on which to run the command.
body = cm_client.ApiRoleNameList() # ApiRoleNameList | List of role names to recommision. (optional)

try:
    # Recommission roles of a service.
    api_response = api_instance.recommission_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->recommission_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | Name of the service on which to run the command.
body = cm_client.ApiRoleNameList() # ApiRoleNameList | List of role names to recommision. (optional)

try:
    # Start and recommission roles of a service.
    api_response = api_instance.recommission_with_start_command(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->recommission_with_start_command: %s\n" % e)

from __future__ import print_function
import time
import cm_client
from cm_client.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ServicesResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service to start.

try:
    # Restart the service.
    api_response = api_instance.restart_command(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServicesResourceApi->restart_command: %s\n" % e)