cm_client.ControlPlanesResourceApi

All URIs are relative to /api/v58

Method HTTP request Description
add_tags PUT /controlPlanes/{controlPlaneUuid}/tags
copy_images_in_features POST /controlPlanes/{controlPlaneUuid}/commands/copyImagesInFeatures
delete_tags DELETE /controlPlanes/{controlPlaneUuid}/tags
generate_copy_docker POST /controlPlanes/commands/generateCopyDocker
generate_external_vault_setup POST /controlPlanes/commands/generateExternalVaultSetup
get_control_planes GET /controlPlanes
get_experience_cluster GET /controlPlanes/{controlPlaneUuid}/getTaggedCluster
get_log_content POST /controlPlanes/fetchResources/{commandId}/logContent
get_manifest_json POST /controlPlanes/fetchResources/manifest.json
install_control_plane POST /controlPlanes/commands/installControlPlane
install_embedded_control_plane POST /controlPlanes/commands/installEmbeddedControlPlane
read_control_plane_by_uuid GET /controlPlanes/{controlPlaneUuid}
read_tags GET /controlPlanes/{controlPlaneUuid}/tags
uninstall_control_plane POST /controlPlanes/{controlPlaneUuid}/commands/uninstallControlPlane
update_values_yaml POST /controlPlanes/{controlPlaneUuid}/commands/updateControlPlaneValuesYaml
upgrade_control_plane POST /controlPlanes/{controlPlaneUuid}/commands/upgradeControlPlane
upgrade_embedded_control_plane POST /controlPlanes/commands/upgradeEmbeddedControlPlane

add_tags

list[ApiEntityTag] add_tags(control_plane_uuid, body=body)

Attach tags to the control plane.

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The uuid of the control plane.
body = [cm_client.ApiEntityTag()] # list[ApiEntityTag] | List of tags to add to the control plane (optional)

try:
    api_response = api_instance.add_tags(control_plane_uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->add_tags: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The uuid of the control plane.
body list[ApiEntityTag] List of tags to add to the control plane [optional]

Return type

list[ApiEntityTag]

Authorization

basic

HTTP request headers

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

copy_images_in_features

ApiCommand copy_images_in_features(control_plane_uuid, body=body)

Launches the command to copy images for one or more features (a comma separated list).

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | 
body = cm_client.ApiCopyImagesInFeaturesArgs() # ApiCopyImagesInFeaturesArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.copy_images_in_features(control_plane_uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->copy_images_in_features: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str
body ApiCopyImagesInFeaturesArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

delete_tags

list[ApiEntityTag] delete_tags(control_plane_uuid, body=body)

Remove the tags associated with the control plane

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The uuid of the control plane.
body = [cm_client.ApiEntityTag()] # list[ApiEntityTag] | A list of tags to remove from the control plane (optional)

try:
    api_response = api_instance.delete_tags(control_plane_uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->delete_tags: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The uuid of the control plane.
body list[ApiEntityTag] A list of tags to remove from the control plane [optional]

Return type

list[ApiEntityTag]

Authorization

basic

HTTP request headers

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

generate_copy_docker

ApiCommand generate_copy_docker(body=body)

Launches the Generate Copy Docker Script 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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiGenerateCopyDockerArgs() # ApiGenerateCopyDockerArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.generate_copy_docker(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->generate_copy_docker: %s\n" % e)

Parameters

Name Type Description Notes
body ApiGenerateCopyDockerArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

generate_external_vault_setup

ApiCommand generate_external_vault_setup(body=body)

Launches the Generate Vault Setup Command 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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiGenerateExternalVaultSetupArgs() # ApiGenerateExternalVaultSetupArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.generate_external_vault_setup(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->generate_external_vault_setup: %s\n" % e)

Parameters

Name Type Description Notes
body ApiGenerateExternalVaultSetupArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

get_control_planes

ApiControlPlaneList get_control_planes()

Current Control Planes

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))

try:
    api_response = api_instance.get_control_planes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->get_control_planes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ApiControlPlaneList

Authorization

basic

HTTP request headers

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

get_experience_cluster

ApiCluster get_experience_cluster(control_plane_uuid)

The cluster with tags matching this control plane's UUID, if any

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The universally unique id of the control plane

try:
    api_response = api_instance.get_experience_cluster(control_plane_uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->get_experience_cluster: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The universally unique id of the control plane

Return type

ApiCluster

Authorization

basic

HTTP request headers

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

get_log_content

str get_log_content(command_id)

Fetches the log content for the specific 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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
command_id = 789 # int | the command id

try:
    api_response = api_instance.get_log_content(command_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->get_log_content: %s\n" % e)

Parameters

Name Type Description Notes
command_id int the command id

Return type

str

Authorization

basic

HTTP request headers

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

get_manifest_json

str get_manifest_json(body=body)

Fetches the manifest.json under the specified remote repo.

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiRemoteRepoUrl() # ApiRemoteRepoUrl | the remote repo url. (optional)

try:
    api_response = api_instance.get_manifest_json(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->get_manifest_json: %s\n" % e)

Parameters

Name Type Description Notes
body ApiRemoteRepoUrl the remote repo url. [optional]

Return type

str

Authorization

basic

HTTP request headers

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

install_control_plane

ApiCommand install_control_plane(body=body)

Launches the install control plane 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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiInstallControlPlaneArgs() # ApiInstallControlPlaneArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.install_control_plane(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->install_control_plane: %s\n" % e)

Parameters

Name Type Description Notes
body ApiInstallControlPlaneArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

install_embedded_control_plane

ApiCommand install_embedded_control_plane(body=body)

Brings up a control plane on embedded kubernetes. At its core, this command launches the FirstRun command on the Containerized Cluster.

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiInstallEmbeddedControlPlaneArgs() # ApiInstallEmbeddedControlPlaneArgs | The arguments for Ek8s control plane installation (optional)

try:
    api_response = api_instance.install_embedded_control_plane(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->install_embedded_control_plane: %s\n" % e)

Parameters

Name Type Description Notes
body ApiInstallEmbeddedControlPlaneArgs The arguments for Ek8s control plane installation [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

read_control_plane_by_uuid

ApiControlPlane read_control_plane_by_uuid(control_plane_uuid)

The control plane with the given 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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The universally unique id of the control plane

try:
    api_response = api_instance.read_control_plane_by_uuid(control_plane_uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->read_control_plane_by_uuid: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The universally unique id of the control plane

Return type

ApiControlPlane

Authorization

basic

HTTP request headers

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

read_tags

list[ApiEntityTag] read_tags(control_plane_uuid, limit=limit, offset=offset)

Returns the tags associated with this control plane.

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The uuid of the control plane.
limit = 56 # int | Number of tags (optional)
offset = 56 # int | Index of the first tag to retrieve (optional)

try:
    api_response = api_instance.read_tags(control_plane_uuid, limit=limit, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->read_tags: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The uuid of the control plane.
limit int Number of tags [optional]
offset int Index of the first tag to retrieve [optional]

Return type

list[ApiEntityTag]

Authorization

basic

HTTP request headers

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

uninstall_control_plane

ApiCommand uninstall_control_plane(control_plane_uuid, body=body)

Launches Uninstall Command on the control plane with the given uuid

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The universally unique id of the control plane
body = cm_client.ApiUninstallControlPlaneArgs() # ApiUninstallControlPlaneArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.uninstall_control_plane(control_plane_uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->uninstall_control_plane: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The universally unique id of the control plane
body ApiUninstallControlPlaneArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

update_values_yaml

ApiCommand update_values_yaml(control_plane_uuid, body=body)

Launches update the values.yaml from the control plane with the given uuid This updates the content of values.yaml.merged in the CM database.

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The universally unique id of the control plane
body = cm_client.ApiUpdateControlPlaneValuesYamlArgs() # ApiUpdateControlPlaneValuesYamlArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.update_values_yaml(control_plane_uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->update_values_yaml: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The universally unique id of the control plane
body ApiUpdateControlPlaneValuesYamlArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

upgrade_control_plane

ApiCommand upgrade_control_plane(control_plane_uuid, body=body)

Launches the Upgrade Command on the control plane with the given uuid

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
control_plane_uuid = 'control_plane_uuid_example' # str | The universally unique id of the control plane
body = cm_client.ApiUpgradeControlPlaneArgs() # ApiUpgradeControlPlaneArgs | Arguments for the Command (optional)

try:
    api_response = api_instance.upgrade_control_plane(control_plane_uuid, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->upgrade_control_plane: %s\n" % e)

Parameters

Name Type Description Notes
control_plane_uuid str The universally unique id of the control plane
body ApiUpgradeControlPlaneArgs Arguments for the Command [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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

upgrade_embedded_control_plane

ApiCommand upgrade_embedded_control_plane(body=body)

Upgrade a Containerized Cluster, including upgrading the control plane running on embedded kubernetes.

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.ControlPlanesResourceApi(cm_client.ApiClient(configuration))
body = cm_client.ApiUpgradeEmbeddedControlPlaneArgs() # ApiUpgradeEmbeddedControlPlaneArgs | The arguments for Ek8s control plane upgrade (optional)

try:
    api_response = api_instance.upgrade_embedded_control_plane(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ControlPlanesResourceApi->upgrade_embedded_control_plane: %s\n" % e)

Parameters

Name Type Description Notes
body ApiUpgradeEmbeddedControlPlaneArgs The arguments for Ek8s control plane upgrade [optional]

Return type

ApiCommand

Authorization

basic

HTTP request headers

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