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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
credstore_dir_path = 'credstore_dir_path_example' # str |  (optional)
force = true # bool |  (optional)
source_account = 'source_account_example' # str |  (optional)

try:
    # Use the following API endpoint instead:.
    api_response = api_instance.create_credstore(cluster_name, service_name, credstore_dir_path=credstore_dir_path, force=force, source_account=source_account)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->create_credstore: %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_schedules

ApiReplicationScheduleList create_schedules(cluster_name, service_name, body=body)

Creates one or more replication schedules.

Creates one or more replication schedules.

Available since API v3. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiReplicationScheduleList() # ApiReplicationScheduleList | List of the replication schedules to create. (optional)

try:
    # Creates one or more replication schedules.
    api_response = api_instance.create_schedules(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->create_schedules: %s\n" % e)

Parameters

Return type

ApiReplicationScheduleList

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_all_schedules

ApiReplicationScheduleList delete_all_schedules(cluster_name, service_name)

Deletes all existing replication schedules.

Deletes all existing replication schedules.

Available since API v3. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Deletes all existing replication schedules.
    api_response = api_instance.delete_all_schedules(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->delete_all_schedules: %s\n" % e)

Parameters

Return type

ApiReplicationScheduleList

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_schedule

ApiReplicationSchedule delete_schedule(cluster_name, schedule_id, service_name)

Deletes an existing replication schedule.

Deletes an existing replication schedule.

Available since API v3. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | Id of an existing replication schedule.
service_name = 'service_name_example' # str | The service name.

try:
    # Deletes an existing replication schedule.
    api_response = api_instance.delete_schedule(cluster_name, schedule_id, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->delete_schedule: %s\n" % e)

Parameters

Return type

ApiReplicationSchedule

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_atlas_entites

ApiCommand export_atlas_entites(cluster_name, service_name, body=body)

Exports the given Atlas Entities (defined in the API body) to a zipped file in hdfs.

Exports the given Atlas Entities (defined in the API body) to a zipped file in 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiAtlasReplicationRemoteArgs() # ApiAtlasReplicationRemoteArgs |  (optional)

try:
    # Exports the given Atlas Entities (defined in the API body) to a zipped file in hdfs.
    api_response = api_instance.export_atlas_entites(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->export_atlas_entites: %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]

export_ranger_services

ApiCommand export_ranger_services(cluster_name, service_name, body=body)

Exports the given Ranger services and policies (defined in the API body) to a zipped file.

Exports the given Ranger services and policies (defined in the API body) to a zipped file.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiRangerReplicationExportArgs() # ApiRangerReplicationExportArgs | the arguments for the export operation.
Contains the Ranger services to be exported. (optional)

try:
    # Exports the given Ranger services and policies (defined in the API body) to a zipped file.
    api_response = api_instance.export_ranger_services(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->export_ranger_services: %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]

fetch_h_base_column_families

ApiCommand fetch_h_base_column_families(cluster_name, service_name, body=body, where_replication_set=where_replication_set)

Starts a command that fetches column families for the desired tables.

Starts a command that fetches column families for the desired tables.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBaseTableNames() # ApiHBaseTableNames | Names of tables to query for column families. (optional)
where_replication_set = false # bool | Whether to retrieve column families of only those tables where there is at least one column family with replication scope set to 1. (optional) (default to false)

try:
    # Starts a command that fetches column families for the desired tables.
    api_response = api_instance.fetch_h_base_column_families(cluster_name, service_name, body=body, where_replication_set=where_replication_set)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->fetch_h_base_column_families: %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]

fetch_h_base_peer_info

ApiCommand fetch_h_base_peer_info(cluster_name, service_name, body=body)

Starts a command that fetches information about an HBase peer by its ID.

Starts a command that fetches information about an HBase peer by its ID.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBasePeerId() # ApiHBasePeerId | ID of the fetched peer. (optional)

try:
    # Starts a command that fetches information about an HBase peer by its ID.
    api_response = api_instance.fetch_h_base_peer_info(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->fetch_h_base_peer_info: %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]

force_delete_schedule

ApiReplicationSchedule force_delete_schedule(cluster_name, schedule_id, service_name)

Deletes an existing replication schedule only from the DB.

Deletes an existing replication schedule only from the DB.

Only the DB schedule reference is deleted with no further cleanup on the source or target side. Typically this endpoint can be used when the source cluster is not available any more and normal policy delete fails during cleanup. Available since API v46. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | Id of an existing replication schedule.
service_name = 'service_name_example' # str | The service name.

try:
    # Deletes an existing replication schedule only from the DB.
    api_response = api_instance.force_delete_schedule(cluster_name, schedule_id, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->force_delete_schedule: %s\n" % e)

Parameters

Return type

ApiReplicationSchedule

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]

generate_cloud_repl_credstore_password

bool generate_cloud_repl_credstore_password(cluster_name, service_name, password_generate_mode=password_generate_mode)

(Re)generates the cloud credential provider password, used by the given service, for replicating to the cloud.

(Re)generates the cloud credential provider password, used by the given service, for replicating to the cloud.
Calling this API endpoint may cause staleness for the given service.
NOTE: If this API endpoint REGENERATED the credstore password successfully and there are existing credstore provider jceks files on HDFS, protected by this password, then these jceks files should be recreated by using the following API endpoint: #recreateCloudCredstoresOnHdfs().

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
password_generate_mode = 'password_generate_mode_example' # str | the CloudReplPasswordGenerateMode to be used for regenerating the password. (optional)

try:
    # (Re)generates the cloud credential provider password, used by the given service, for replicating to the cloud.
    api_response = api_instance.generate_cloud_repl_credstore_password(cluster_name, service_name, password_generate_mode=password_generate_mode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->generate_cloud_repl_credstore_password: %s\n" % e)

Parameters

Return type

bool

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_replication_state

ApiReplicationState get_replication_state(cluster_name, service_name, view=view)

returns the replication state.

returns the replication state. for example if incremental export is enabled, etc

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
view = 'summary' # str | view to materialize (optional) (default to summary)

try:
    # returns the replication state.
    api_response = api_instance.get_replication_state(cluster_name, service_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->get_replication_state: %s\n" % e)

Parameters

Return type

ApiReplicationState

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]

is_hive3_reverse_direction_enabled

bool is_hive3_reverse_direction_enabled(cluster_name, service_name, cluster_uuid_on_remote=cluster_uuid_on_remote, service_name_on_remote=service_name_on_remote, source_db_name_on_remote=source_db_name_on_remote, target_db_name_on_remote=target_db_name_on_remote)

This API endpoint checks if there is an ENABLED Hive3 replication policy on this server that replicates for the reverse direction.

This API endpoint checks if there is an ENABLED Hive3 replication policy on this server that replicates for the reverse direction. Bidirectional Hive3 replication policies are allowed, but only one direction can be ENABLED at the same time.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
cluster_uuid_on_remote = 'cluster_uuid_on_remote_example' # str | the uuid of the cluster on the remote CM server (optional)
service_name_on_remote = 'service_name_on_remote_example' # str | the Hive3 service name on the remote CM server, more specifically on the cluster specified by clusterUuidOnRemote (optional)
source_db_name_on_remote = 'source_db_name_on_remote_example' # str | the name of the source database on the remote CM server (optional)
target_db_name_on_remote = 'target_db_name_on_remote_example' # str | the name of the target database on the remote CM server (optional)

try:
    # This API endpoint checks if there is an ENABLED Hive3 replication policy on this server that replicates for the reverse direction.
    api_response = api_instance.is_hive3_reverse_direction_enabled(cluster_name, service_name, cluster_uuid_on_remote=cluster_uuid_on_remote, service_name_on_remote=service_name_on_remote, source_db_name_on_remote=source_db_name_on_remote, target_db_name_on_remote=target_db_name_on_remote)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->is_hive3_reverse_direction_enabled: %s\n" % e)

Parameters

Return type

bool

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]

list_h_base_namespaces

ApiCommand list_h_base_namespaces(cluster_name, service_name)

Starts a command that lists all namespaces in HBase.

Starts a command that lists all namespaces in 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Starts a command that lists all namespaces in HBase.
    api_response = api_instance.list_h_base_namespaces(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->list_h_base_namespaces: %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]

list_h_base_peers

ApiCommand list_h_base_peers(cluster_name, service_name)

Starts a command that retrieves all peers registered in the HBase service.

Starts a command that retrieves all peers registered in the 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Starts a command that retrieves all peers registered in the HBase service.
    api_response = api_instance.list_h_base_peers(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->list_h_base_peers: %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]

list_h_base_tables

ApiCommand list_h_base_tables(cluster_name, service_name)

Starts a command that lists tables from the HBase service.

Starts a command that lists tables from the 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Starts a command that lists tables from the HBase service.
    api_response = api_instance.list_h_base_tables(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->list_h_base_tables: %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]

post_copy_reconciliation

ApiCommand post_copy_reconciliation(cluster_name, schedule_id, service_name, pcr_enable_crc_check=pcr_enable_crc_check, pcr_enable_length_check=pcr_enable_length_check, pcr_enable_modtime_check=pcr_enable_modtime_check)

Starts a command that executes PostCopyReconciliation steps on a schedule.

Starts a command that executes PostCopyReconciliation steps on a schedule.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | 
service_name = 'service_name_example' # str | The service name.
pcr_enable_crc_check = true # bool |  (optional) (default to true)
pcr_enable_length_check = true # bool |  (optional) (default to true)
pcr_enable_modtime_check = true # bool |  (optional) (default to true)

try:
    # Starts a command that executes PostCopyReconciliation steps on a schedule.
    api_response = api_instance.post_copy_reconciliation(cluster_name, schedule_id, service_name, pcr_enable_crc_check=pcr_enable_crc_check, pcr_enable_length_check=pcr_enable_length_check, pcr_enable_modtime_check=pcr_enable_modtime_check)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->post_copy_reconciliation: %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]

read_history

ApiReplicationCommandList read_history(cluster_name, schedule_id, service_name, limit=limit, offset=offset, sort=sort, status=status, view=view)

Returns a list of commands triggered by a schedule.

Returns a list of commands triggered by a schedule.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | ID of an existing replication schedule.
service_name = 'service_name_example' # str | The service name.
limit = 20 # int | Maximum number of commands to retrieve. Optional, default value is 20. (optional) (default to 20)
offset = 0 # int | Index of first command to retrieve. Optional, default value is 0. (optional) (default to 0)
sort = 'sort_example' # str | The list of fields to order by. The value passed should be in the format of orderBy=field1:asc,field2:desc, where field1 will have the highest precedence. For every field provided, asc or  also has to be provided. This param is optional, default behaviour is descending ordering by start time. (optional)
status = 'status_example' # str | Desired status of retrieved commands. Optional, default behaviour is not applying any filtering, and returning all commands. Check ApiReplicationHistoryItemStatus for possible values. (optional)
view = 'summary' # str | The view to materialize. Optional, default is summary. (optional) (default to summary)

try:
    # Returns a list of commands triggered by a schedule.
    api_response = api_instance.read_history(cluster_name, schedule_id, service_name, limit=limit, offset=offset, sort=sort, status=status, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->read_history: %s\n" % e)

Parameters

Return type

ApiReplicationCommandList

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]

read_schedule

ApiReplicationSchedule read_schedule(cluster_name, schedule_id, service_name, view=view)

Returns information for a specific replication schedule.

Returns information for a specific replication schedule.

Available since API v3. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | Id of an existing replication schedule.
service_name = 'service_name_example' # str | The service name.
view = 'summary' # str | The view to materialize. (optional) (default to summary)

try:
    # Returns information for a specific replication schedule.
    api_response = api_instance.read_schedule(cluster_name, schedule_id, service_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->read_schedule: %s\n" % e)

Parameters

Return type

ApiReplicationSchedule

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]

read_schedules

ApiReplicationScheduleList read_schedules(cluster_name, service_name, max_commands=max_commands, max_errors=max_errors, max_schedules=max_schedules, max_tables=max_tables, view=view)

Retrieves information about replication schedules.

Retrieves information about replication schedules.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
max_commands = 0 # int | Maximum number of commands to include in the history of replication schedules. By default, it has no limit. Pass 0 to explicitly set to unlimited. (optional) (default to 0)
max_errors = 0 # int | Maximum number of errors per Hive replication command. By default, it has no limit. Pass 0 to explicitly set to unlimited. (optional) (default to 0)
max_schedules = 0 # int | Maximum number of replication schedules to be included in the response. By default, it has no limit. Pass 0 to explicitly set to unlimited. (optional) (default to 0)
max_tables = 0 # int | Maximum number of tables per Hive replication command. By default, it has no limit. Pass 0 to explicitly set to unlimited. (optional) (default to 0)
view = 'summary' # str | The view to materialize. (optional) (default to summary)

try:
    # Retrieves information about replication schedules.
    api_response = api_instance.read_schedules(cluster_name, service_name, max_commands=max_commands, max_errors=max_errors, max_schedules=max_schedules, max_tables=max_tables, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->read_schedules: %s\n" % e)

Parameters

Return type

ApiReplicationScheduleList

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]

recreate_cloud_credstores_on_hdfs

ApiCommand recreate_cloud_credstores_on_hdfs(cluster_name, service_name)

Recreates the existing credential provider jceks files on HDFS, that are used by the given service, for replicating to the cloud.

Recreates the existing credential provider jceks files on HDFS, that are used by the given service, for replicating to the 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.

try:
    # Recreates the existing credential provider jceks files on HDFS, that are used by the given service, for replicating to the cloud.
    api_response = api_instance.recreate_cloud_credstores_on_hdfs(cluster_name, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->recreate_cloud_credstores_on_hdfs: %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]

remove_h_base_peer

ApiCommand remove_h_base_peer(cluster_name, service_name, body=body)

Starts a command that removes the specified HBase replication peer from the local HBase service.

Starts a command that removes the specified HBase replication peer from the local 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBasePeerId() # ApiHBasePeerId | ID of the peer to be removed. (optional)

try:
    # Starts a command that removes the specified HBase replication peer from the local HBase service.
    api_response = api_instance.remove_h_base_peer(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->remove_h_base_peer: %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]

remove_tables_from_h_base_peer

ApiCommand remove_tables_from_h_base_peer(cluster_name, service_name, body=body)

Starts a command that removes tables and column families from an existing HBase replication peer.

Starts a command that removes tables and column families from an existing HBase replication 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBasePeerIdWithTableCFs() # ApiHBasePeerIdWithTableCFs | Arguments for removing tables from HBase replication peer. (optional)

try:
    # Starts a command that removes tables and column families from an existing HBase replication peer.
    api_response = api_instance.remove_tables_from_h_base_peer(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->remove_tables_from_h_base_peer: %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]

reschedule_hive3_replication_metrics_getter

bool reschedule_hive3_replication_metrics_getter(cluster_name, service_name, next_start_mins=next_start_mins)

Set the Hive3 Replication Metrics Getter next start time.

Set the Hive3 Replication Metrics Getter next start time.

(Re)set the Hive3 Replication Metrics Getter next start time. Should be only used if the Getter needs to be manually started.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
next_start_mins = 5 # int |  (optional) (default to 5)

try:
    # Set the Hive3 Replication Metrics Getter next start time.
    api_response = api_instance.reschedule_hive3_replication_metrics_getter(cluster_name, service_name, next_start_mins=next_start_mins)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->reschedule_hive3_replication_metrics_getter: %s\n" % e)

Parameters

Return type

bool

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]

run_copy_listing

ApiCommand run_copy_listing(cluster_name, service_name, body=body)

Run the hdfs copy listing command.

Run the hdfs copy listing command

The copy listing command will be triggered with the provided arguments

Available since API v18. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = 'body_example' # str |  (optional)

try:
    # Run the hdfs copy listing command.
    api_response = api_instance.run_copy_listing(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->run_copy_listing: %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]

run_h_base_replication_retry_failed_snapshots

ApiCommand run_h_base_replication_retry_failed_snapshots(cluster_name, schedule_id, service_name)

Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID.

Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | The HBase schedule ID to retry on
service_name = 'service_name_example' # str | The service name.

try:
    # Executes a command to run a HBase replication retry on failed snapshots for the given schedule ID.
    api_response = api_instance.run_h_base_replication_retry_failed_snapshots(cluster_name, schedule_id, service_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->run_h_base_replication_retry_failed_snapshots: %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]

run_h_base_replication_security_tool

ApiCommand run_h_base_replication_security_tool(cluster_name, service_name, body=body)

Run the hbase replication security tool.

Run the hbase replication security tool

The replication security tool is invoked against the provided 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = NULL # dict(str, str) |  (optional)

try:
    # Run the hbase replication security tool.
    api_response = api_instance.run_h_base_replication_security_tool(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->run_h_base_replication_security_tool: %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]

run_h_base_replication_validation_tool

ApiCommand run_h_base_replication_validation_tool(cluster_name, service_name, hbase_peer_id=hbase_peer_id)

Executes a command, which validates if HBase replication works properly for the given hbasePeerId.

Executes a command, which validates if HBase replication works properly for the given hbasePeerId

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
hbase_peer_id = 'hbase_peer_id_example' # str | The HBase peer ID to be validated (optional)

try:
    # Executes a command, which validates if HBase replication works properly for the given hbasePeerId.
    api_response = api_instance.run_h_base_replication_validation_tool(cluster_name, service_name, hbase_peer_id=hbase_peer_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->run_h_base_replication_validation_tool: %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]

run_hive_replication_query

ApiCommand run_hive_replication_query(cluster_name, service_name, body=body)

Execute a hive replication query on local HS2 service instance.

Execute a hive replication query on local HS2 service instance

The command executes hive replication query on local HS2 instance with the provided 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHive3ReplicationArguments() # ApiHive3ReplicationArguments |  (optional)

try:
    # Execute a hive replication query on local HS2 service instance.
    api_response = api_instance.run_hive_replication_query(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->run_hive_replication_query: %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]

run_schedule

ApiCommand run_schedule(cluster_name, schedule_id, service_name, dry_run=dry_run)

Run the schedule immediately.

Run the schedule immediately.

The replication command will be triggered with the configured arguments, and will be recorded in the schedule's history.

Available since API v3. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | Id of an existing replication schedule.
service_name = 'service_name_example' # str | The service name.
dry_run = false # bool | Whether to execute a dry run. (optional) (default to false)

try:
    # Run the schedule immediately.
    api_response = api_instance.run_schedule(cluster_name, schedule_id, service_name, dry_run=dry_run)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->run_schedule: %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]

set_cfs_replication_scope

ApiCommand set_cfs_replication_scope(cluster_name, service_name, body=body)

Starts a command that set the replication scope of the provided column families to the desired value.

Starts a command that set the replication scope of the provided column families to the desired value.

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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBaseSetCFsReplicationScope() # ApiHBaseSetCFsReplicationScope | Arguments for setting the replication scope. (optional)

try:
    # Starts a command that set the replication scope of the provided column families to the desired value.
    api_response = api_instance.set_cfs_replication_scope(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->set_cfs_replication_scope: %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]

update_h_base_peer_state

ApiCommand update_h_base_peer_state(cluster_name, service_name, body=body)

Update HBase peer state ('DISABLE' or 'ENABLE'),.

Update HBase peer state ('DISABLE' or 'ENABLE'),
and set the related HBase replication schedules

ApiHBaseReplicationArguments.peerState

  example json data payload:  '{     "sourceRef": {       "peerName": "source-peer-name",       "clusterName": "Cluster Name",       "serviceName": "HBase Service Name"     }     "peerState": "ENABLED|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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBaseReplicationUpdatePeerStateArgs() # ApiHBaseReplicationUpdatePeerStateArgs | ApiHBaseReplicationUpdatePeerStateArgs (optional)

try:
    # Update HBase peer state ('DISABLE' or 'ENABLE'),.
    api_response = api_instance.update_h_base_peer_state(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->update_h_base_peer_state: %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]

update_h_base_replication_peer_state

ApiCommand update_h_base_replication_peer_state(cluster_name, service_name, body=body)

Starts a command that updates the state of an existing HBase replication peer.

Starts a command that updates the state of an existing HBase replication 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiHBaseUpdateReplicationPeerState() # ApiHBaseUpdateReplicationPeerState | Arguments for operation. (optional)

try:
    # Starts a command that updates the state of an existing HBase replication peer.
    api_response = api_instance.update_h_base_replication_peer_state(cluster_name, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->update_h_base_replication_peer_state: %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]

update_schedule

ApiReplicationSchedule update_schedule(cluster_name, schedule_id, service_name, body=body)

Updates an existing replication schedule.

Updates an existing replication schedule.

Available since API v3. 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.ReplicationsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
schedule_id = 56 # int | Id of an existing replication schedule.
service_name = 'service_name_example' # str | The service name.
body = cm_client.ApiReplicationSchedule() # ApiReplicationSchedule |  (optional)

try:
    # Updates an existing replication schedule.
    api_response = api_instance.update_schedule(cluster_name, schedule_id, service_name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReplicationsResourceApi->update_schedule: %s\n" % e)

Parameters

Return type

ApiReplicationSchedule

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]