diff --git a/.DS_Store b/.DS_Store deleted file mode 100644 index c5c864be1..000000000 Binary files a/.DS_Store and /dev/null differ diff --git a/.dockerignore b/.dockerignore deleted file mode 100644 index 299a20858..000000000 --- a/.dockerignore +++ /dev/null @@ -1,6 +0,0 @@ -.gitignore -LICENSE -*.md -reference/ -.mypy_cache/ -.pytest_cache/ diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 448ab4da3..000000000 --- a/.gitignore +++ /dev/null @@ -1,108 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Docs -_build/ - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# pyenv -.python-version - -# celery beat schedule file -celerybeat-schedule - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.vscode/settings.json diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 36df43c44..000000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,25 +0,0 @@ -repos: -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: 'v2.1.0' - hooks: - - id: trailing-whitespace - - id: check-executables-have-shebangs - - id: check-merge-conflict - - id: debug-statements - - id: end-of-file-fixer - - id: fix-encoding-pragma -- repo: https://github.com/antonbabenko/pre-commit-terraform - rev: 'v1.11.0' - hooks: - - id: terraform_fmt - - id: terraform_docs -- repo: https://github.com/jumanjihouse/pre-commit-hooks - sha: '1.11.0' - hooks: - - id: forbid-binary - - id: markdownlint - - id: require-ascii -- repo: https://github.com/pre-commit/mirrors-isort - rev: 'v4.3.17' - hooks: - - id: isort diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 02e7d6a74..000000000 --- a/.travis.yml +++ /dev/null @@ -1,53 +0,0 @@ -language: python -dist: xenial -sudo: true -os: - - linux -install: "make" - -services: - - docker - -cache: pip - -script: - - | - if [[ "$TRAVIS_PYTHON_VERSION" != "2.6" ]] ; then make test-readme; fi - - make ci - -jobs: - include: - - stage: lint - script: - - make lint - python: '3.7' - - stage: test - script: - - make ci - python: '3.6' - - stage: test - script: - - make ci - python: '3.7' - dist: xenial - # - stage: test - # script: - # - make ci - # python: '3.8' - # dist: xenial - - stage: coverage - python: '3.7' - script: codecov - - stage: build-docs - python: '3.7' - script: pydocmd build - deploy: - provider: pages - skip-cleanup: true - github-token: $GITHUB_TOKEN - keep-history: true - local-dir: _build/site - fqdn: cloudendurepy.github.io - target-branch: gh-pages - on: - branch: master diff --git a/404.html b/404.html new file mode 100644 index 000000000..f9932c36b --- /dev/null +++ b/404.html @@ -0,0 +1,1800 @@ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +This Python package is automatically generated by the Swagger Codegen project:
+50.1.7io.swagger.codegen.v3.generators.python.PythonClientCodegenIf the python package is hosted on Github, you can install directly from Github
+poetry install cloudendure
+
+
+Then import the package:
+from cloudendure import cloudendure_api
+
+
+Please follow the installation procedure and then run the following:
+import time
+
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+
+# create an instance of the API class
+api_instance = cloudendure_api.AccountApi(cloudendure_api.ApiClient(configuration))
+account_id = 'account_id_example' # str |
+
+try:
+ # Get Account information
+ api_response = api_instance.accounts_account_id_get(account_id)
+ print(api_response)
+except ApiException as e:
+ print('Exception when calling AccountApi->accounts_account_id_get: %s\n '% e)
+
+
+
+All URIs are relative to https://console.cloudendure.com/api/latest
+| Class | +Method | +HTTP request | +Description | +
|---|---|---|---|
| AccountApi | +accounts_account_id_get | +GET /accounts/{accountId} | +Get Account information | +
| ActionsApi | +projects_project_id_find_files_post | +POST /projects/{projectId}/findFiles | +Search for files in a backup project | +
| ActionsApi | +projects_project_id_jobs_get | +GET /projects/{projectId}/jobs | +List Jobs | +
| ActionsApi | +projects_project_id_jobs_job_id_get | +GET /projects/{projectId}/jobs/{jobId} | +Get Job | +
| ActionsApi | +projects_project_id_launch_machines_post | +POST /projects/{projectId}/launchMachines | +Launch target machines | +
| ActionsApi | +projects_project_id_launch_restore_servers_post | +POST /projects/{projectId}/launchRestoreServers | +Launch restore servers @todo | +
| ActionsApi | +projects_project_id_move_machines_post | +POST /projects/{projectId}/moveMachines | +Moves machines to another project | +
| ActionsApi | +projects_project_id_pause_replication_post | +POST /projects/{projectId}/pauseReplication | +Pause replication | +
| ActionsApi | +projects_project_id_replicas_delete | +DELETE /projects/{projectId}/replicas | +Perform Cleanup | +
| ActionsApi | +projects_project_id_restore_files_post | +POST /projects/{projectId}/restoreFiles | +Restore selected files in a backup project | +
| ActionsApi | +projects_project_id_reverse_replication_post | +POST /projects/{projectId}/reverseReplication | +Reverse replication direction | +
| ActionsApi | +projects_project_id_start_replication_post | +POST /projects/{projectId}/startReplication | +Start replication | +
| ActionsApi | +projects_project_id_stop_replication_post | +POST /projects/{projectId}/stopReplication | +Stop replication | +
| AuthenticationApi | +login_post | +POST /login | +Login | +
| AuthenticationApi | +logout_post | +POST /logout | +Logout | +
| BlueprintApi | +projects_project_id_blueprints_blueprint_id_get | +GET /projects/{projectId}/blueprints/{blueprintId} | +Get Blueprint | +
| BlueprintApi | +projects_project_id_blueprints_blueprint_id_patch | +PATCH /projects/{projectId}/blueprints/{blueprintId} | +Configure Blueprint | +
| BlueprintApi | +projects_project_id_blueprints_get | +GET /projects/{projectId}/blueprints | +List Blueprints | +
| BlueprintApi | +projects_project_id_blueprints_post | +POST /projects/{projectId}/blueprints | +Create Blueprint | +
| CloudApi | +cloud_credentials_creds_id_regions_get | +GET /cloudCredentials/{credsId}/regions | +List Regions | +
| CloudApi | +cloud_credentials_creds_id_regions_region_id_delete | +DELETE /cloudCredentials/{credsId}/regions/{regionId} | +Delete region (VCenter) | +
| CloudApi | +cloud_credentials_creds_id_regions_region_id_get | +GET /cloudCredentials/{credsId}/regions/{regionId} | +Get Region | +
| CloudApi | +cloud_credentials_creds_id_regions_region_id_patch | +PATCH /cloudCredentials/{credsId}/regions/{regionId} | +Patch region (rename) | +
| CloudApi | +clouds_get | +GET /clouds | +List Clouds | +
| CloudCredentialsApi | +cloud_credentials_creds_id_get | +GET /cloudCredentials/{credsId} | +Get Credentials | +
| CloudCredentialsApi | +cloud_credentials_creds_id_patch | +PATCH /cloudCredentials/{credsId} | +Change Credentials | +
| CloudCredentialsApi | +cloud_credentials_get | +GET /cloudCredentials | +List Credentials | +
| CloudCredentialsApi | +cloud_credentials_post | +POST /cloudCredentials | +Create Credentials | +
| DefaultApi | +accounts_account_id_access_get | +GET /accounts/{accountId}/access | +get a temporary token by email | +
| DefaultApi | +extended_account_info_get | +GET /extendedAccountInfo | +Returns the extended current account information. | +
| DefaultApi | +projects_assign_users_post | +POST /projects/assignUsers | +todo | +
| DefaultApi | +projects_project_id_audit_log_get | +GET /projects/{projectId}/auditLog | +Get audit log | +
| DefaultApi | +projects_project_id_storage_get | +GET /projects/{projectId}/storage | +project's storage | +
| DefaultApi | +projects_remove_users_post | +POST /projects/removeUsers | +todo | +
| DefaultApi | +replace_api_token_post | +POST /replaceApiToken | +Replaces API token | +
| DefaultApi | +set_password_post | +POST /setPassword | +Set password for invited user | +
| DefaultApi | +users_assign_roles_post | +POST /users/assignRoles | +Add roles to users | +
| DefaultApi | +users_post | +POST /users | +Create a new User | +
| DefaultApi | +users_revoke_roles_post | +POST /users/revokeRoles | +Add roles to users | +
| LicensingApi | +licenses_get | +GET /licenses | +List Licenses | +
| LicensingApi | +licenses_license_id_get | +GET /licenses/{licenseId} | +Get License | +
| MachinesApi | +projects_project_id_machines_delete | +DELETE /projects/{projectId}/machines | +Uninstall agent | +
| MachinesApi | +projects_project_id_machines_get | +GET /projects/{projectId}/machines | +List Machines | +
| MachinesApi | +projects_project_id_machines_machine_id_get | +GET /projects/{projectId}/machines/{machineId} | +Get a specific machine. | +
| MachinesApi | +projects_project_id_machines_machine_id_patch | +PATCH /projects/{projectId}/machines/{machineId} | +Update a machine. Accepts only Launch time updates. | +
| MachinesApi | +projects_project_id_machines_patch | +PATCH /projects/{projectId}/machines | +Batch-update multiple machines | +
| MachinesApi | +projects_project_id_replicas_replica_id_get | +GET /projects/{projectId}/replicas/{replicaId} | +Get Target Machine | +
| ProjectApi | +projects_get | +GET /projects | +List Projects | +
| ProjectApi | +projects_post | +POST /projects | +Create Project | +
| ProjectApi | +projects_project_id_delete | +DELETE /projects/{projectId} | +Delete Project and all sub-resources including cloud assets other than launched target machines | +
| ProjectApi | +projects_project_id_get | +GET /projects/{projectId} | +Get Project | +
| ProjectApi | +projects_project_id_patch | +PATCH /projects/{projectId} | +Update Project (including partial update) | +
| ProjectApi | +projects_project_id_tags_get | +GET /projects/{projectId}/tags | +Gets all instance tags of all machines in the project. | +
| RecoveryPlansApi | +projects_project_id_recovery_plans_get | +GET /projects/{projectId}/recoveryPlans | +Gets all recovery plans for the project. | +
| RecoveryPlansApi | +projects_project_id_recovery_plans_post | +POST /projects/{projectId}/recoveryPlans | +Creates a new recovery plan. | +
| RecoveryPlansApi | +projects_project_id_recovery_plans_recovery_plan_id_delete | +DELETE /projects/{projectId}/recoveryPlans/{recoveryPlanId} | +Deletes a recovery plan. | +
| RecoveryPlansApi | +projects_project_id_recovery_plans_recovery_plan_id_get | +GET /projects/{projectId}/recoveryPlans/{recoveryPlanId} | +Gets a recovery plan. | +
| RecoveryPlansApi | +projects_project_id_recovery_plans_recovery_plan_id_patch | +PATCH /projects/{projectId}/recoveryPlans/{recoveryPlanId} | +Updates a new recovery plan. | +
| RecoveryPlansApi | +projects_project_id_run_recovery_plan_post | +POST /projects/{projectId}/runRecoveryPlan | +Launch a recovery plan. | +
| ReplicationApi | +projects_project_id_machines_machine_id_bandwidth_throttling_get | +GET /projects/{projectId}/machines/{machineId}/bandwidthThrottling | +Get value of network bandwidth throttling setting for Machine | +
| ReplicationApi | +projects_project_id_machines_machine_id_bandwidth_throttling_patch | +PATCH /projects/{projectId}/machines/{machineId}/bandwidthThrottling | +Set value of network bandwidth throttling setting for Machine | +
| ReplicationApi | +projects_project_id_machines_machine_id_delete | +DELETE /projects/{projectId}/machines/{machineId} | +Uninstall agent | +
| ReplicationApi | +projects_project_id_machines_machine_id_pointsintime_get | +GET /projects/{projectId}/machines/{machineId}/pointsintime | +List Available Points-in-time | +
| ReplicationApi | +projects_project_id_replication_configurations_get | +GET /projects/{projectId}/replicationConfigurations | +List Replication Configurations | +
| ReplicationApi | +projects_project_id_replication_configurations_post | +POST /projects/{projectId}/replicationConfigurations | +Create Replication Configuration | +
| ReplicationApi | +projects_project_id_replication_configurations_replication_configuration_id_patch | +PATCH /projects/{projectId}/replicationConfigurations/{replicationConfigurationId} | +Modify Replication Configuration | +
| UserApi | +change_password_post | +POST /changePassword | +Change Password | +
| UserApi | +me_get | +GET /me | +Me | +
| UserApi | +users_user_id_delete | +DELETE /users/{userId} | +Delete a User | +
| UserApi | +users_user_id_patch | +PATCH /users/{userId} | +Modify user settings | +
All endpoints do not require authorization.
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| accounts_account_id_get | +GET /accounts/{accountId} | +Get Account information | +
++CloudEndureAccount accounts_account_id_get(account_id)
+
Get Account information
+from __future__ import print_function
+
+import time
+
+from pprint import pprint
+
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+
+
+# create an instance of the API class
+api_instance = cloudendure_api.AccountApi()
+account_id = 'account_id_example' # str |
+
+try:
+ # Get Account information
+ api_response = api_instance.accounts_account_id_get(account_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AccountApi->accounts_account_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| account_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| projects_project_id_find_files_post | +POST /projects/{projectId}/findFiles | +Search for files in a backup project | +
| projects_project_id_jobs_get | +GET /projects/{projectId}/jobs | +List Jobs | +
| projects_project_id_jobs_job_id_get | +GET /projects/{projectId}/jobs/{jobId} | +Get Job | +
| projects_project_id_launch_machines_post | +POST /projects/{projectId}/launchMachines | +Launch target machines | +
| projects_project_id_launch_restore_servers_post | +POST /projects/{projectId}/launchRestoreServers | +Launch restore servers @todo | +
| projects_project_id_move_machines_post | +POST /projects/{projectId}/moveMachines | +Moves machines to another project | +
| projects_project_id_pause_replication_post | +POST /projects/{projectId}/pauseReplication | +Pause replication | +
| projects_project_id_replicas_delete | +DELETE /projects/{projectId}/replicas | +Perform Cleanup | +
| projects_project_id_restore_files_post | +POST /projects/{projectId}/restoreFiles | +Restore selected files in a backup project | +
| projects_project_id_reverse_replication_post | +POST /projects/{projectId}/reverseReplication | +Reverse replication direction | +
| projects_project_id_start_replication_post | +POST /projects/{projectId}/startReplication | +Start replication | +
| projects_project_id_stop_replication_post | +POST /projects/{projectId}/stopReplication | +Stop replication | +
++CloudEndureFindFilesResults projects_project_id_find_files_post(body, project_id)
+
Search for files in a backup project
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = cloudendure_api.CloudEndureFindFilesParameters() # CloudEndureFindFilesParameters | The query string and the machine id's to use it in
+project_id = 'project_id_example' # str |
+
+try:
+ # Search for files in a backup project
+ api_response = api_instance.projects_project_id_find_files_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_find_files_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureFindFilesParameters | +The query string and the machine id's to use it in | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJobsList projects_project_id_jobs_get(project_id, offset=offset, limit=limit)
+
List Jobs
+Returns the list of jobs in the project.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+project_id = 'project_id_example' # str |
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Jobs
+ api_response = api_instance.projects_project_id_jobs_get(project_id, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_jobs_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJob projects_project_id_jobs_job_id_get(project_id, job_id)
+
Get Job
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+project_id = 'project_id_example' # str |
+job_id = 'job_id_example' # str |
+
+try:
+ # Get Job
+ api_response = api_instance.projects_project_id_jobs_job_id_get(project_id, job_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_jobs_job_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| job_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJob projects_project_id_launch_machines_post(body, project_id)
+
Launch target machines
+Launch target machines for test, recovery or cutover (by passing enum value to launchType param)
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = cloudendure_api.CloudEndureLaunchMachinesParameters() # CloudEndureLaunchMachinesParameters | Machines to launch
+project_id = 'project_id_example' # str |
+
+try:
+ # Launch target machines
+ api_response = api_instance.projects_project_id_launch_machines_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_launch_machines_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureLaunchMachinesParameters | +Machines to launch | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJob projects_project_id_launch_restore_servers_post(body, project_id)
+
Launch restore servers @todo
+todo
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = cloudendure_api.CloudEndureLaunchMachinesParameters() # CloudEndureLaunchMachinesParameters | todo
+project_id = 'project_id_example' # str |
+
+try:
+ # Launch restore servers @todo
+ api_response = api_instance.projects_project_id_launch_restore_servers_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_launch_restore_servers_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureLaunchMachinesParameters | +todo | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_project_id_move_machines_post(body, project_id)
+
Moves machines to another project
+TBC
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = NULL # object |
+project_id = 'project_id_example' # str |
+
+try:
+ # Moves machines to another project
+ api_instance.projects_project_id_move_machines_post(body, project_id)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_move_machines_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | ++ | + |
| project_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachinesListInvalidIDsAndJob projects_project_id_pause_replication_post(body, project_id)
+
Pause replication
+Pause replication for given machines
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = NULL # object | The machine IDs for which to pause replication.
+project_id = 'project_id_example' # str |
+
+try:
+ # Pause replication
+ api_response = api_instance.projects_project_id_pause_replication_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_pause_replication_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +The machine IDs for which to pause replication. | ++ |
| project_id | +str | ++ | + |
CloudEndureMachinesListInvalidIDsAndJob
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJob projects_project_id_replicas_delete(body, project_id)
+
Perform Cleanup
+Spawns a cleanup job to remove the specified target machines from the cloud. Returns the job information.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = NULL # object | The list of replica IDs to delete (corresponding to the 'replica' field in the machine object.
+project_id = 'project_id_example' # str |
+
+try:
+ # Perform Cleanup
+ api_response = api_instance.projects_project_id_replicas_delete(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_replicas_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +The list of replica IDs to delete (corresponding to the 'replica' field in the machine object. | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJob projects_project_id_restore_files_post(body, project_id)
+
Restore selected files in a backup project
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = cloudendure_api.CloudEndureRestoreFilesParameters() # CloudEndureRestoreFilesParameters | A list of file origins, each origin includes file path, machine id, and pit id.
+project_id = 'project_id_example' # str |
+
+try:
+ # Restore selected files in a backup project
+ api_response = api_instance.projects_project_id_restore_files_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_restore_files_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureRestoreFilesParameters | +A list of file origins, each origin includes file path, machine id, and pit id. | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_project_id_reverse_replication_post(project_id)
+
Reverse replication direction
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+project_id = 'project_id_example' # str |
+
+try:
+ # Reverse replication direction
+ api_instance.projects_project_id_reverse_replication_post(project_id)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_reverse_replication_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachinesListInvalidIDsAndJob projects_project_id_start_replication_post(body, project_id)
+
Start replication
+Start replication of the specified source machines. Returns the machine for which replication has been successfully started, and the IDs for which replication could not be started.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = NULL # object | Specification of the machines for which replication will start.
+project_id = 'project_id_example' # str |
+
+try:
+ # Start replication
+ api_response = api_instance.projects_project_id_start_replication_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_start_replication_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +Specification of the machines for which replication will start. | ++ |
| project_id | +str | ++ | + |
CloudEndureMachinesListInvalidIDsAndJob
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachinesListInvalidIDsAndJob projects_project_id_stop_replication_post(body, project_id)
+
Stop replication
+Stop replication of the specified source machines. Returns the machine for which replication has been successfully stopped, and the IDs for which replication could not be stopped.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ActionsApi()
+body = NULL # object | Specification of the machines for which replication will stop.
+project_id = 'project_id_example' # str |
+
+try:
+ # Stop replication
+ api_response = api_instance.projects_project_id_stop_replication_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ActionsApi->projects_project_id_stop_replication_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +Specification of the machines for which replication will stop. | ++ |
| project_id | +str | ++ | + |
CloudEndureMachinesListInvalidIDsAndJob
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| login_post | +POST /login | +Login | +
| logout_post | +POST /logout | +Logout | +
++CloudEndureUser login_post(body)
+
Login
+@todo: fix re use of XSRF-TOKEN cookie + X-XSRF-TOKEN header Upon successful authentication, this method returns a session identifier cookie that can be used to authenticate subsequent API calls.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.AuthenticationApi()
+body = NULL # object | Login info
+
+try:
+ # Login
+ api_response = api_instance.login_post(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling AuthenticationApi->login_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +Login info | ++ |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++logout_post()
+
Logout
+Invalidates the session identifier associated with this session.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.AuthenticationApi()
+
+try:
+ # Logout
+ api_instance.logout_post()
+except ApiException as e:
+ print("Exception when calling AuthenticationApi->logout_post: %s\n" % e)
+
+
+This endpoint does not need any parameter.
+void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| projects_project_id_blueprints_blueprint_id_get | +GET /projects/{projectId}/blueprints/{blueprintId} | +Get Blueprint | +
| projects_project_id_blueprints_blueprint_id_patch | +PATCH /projects/{projectId}/blueprints/{blueprintId} | +Configure Blueprint | +
| projects_project_id_blueprints_get | +GET /projects/{projectId}/blueprints | +List Blueprints | +
| projects_project_id_blueprints_post | +POST /projects/{projectId}/blueprints | +Create Blueprint | +
++CloudEndureBlueprint projects_project_id_blueprints_blueprint_id_get(project_id, blueprint_id)
+
Get Blueprint
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.BlueprintApi()
+project_id = 'project_id_example' # str |
+blueprint_id = 'blueprint_id_example' # str |
+
+try:
+ # Get Blueprint
+ api_response = api_instance.projects_project_id_blueprints_blueprint_id_get(project_id, blueprint_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling BlueprintApi->projects_project_id_blueprints_blueprint_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| blueprint_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureBlueprint projects_project_id_blueprints_blueprint_id_patch(body, project_id, blueprint_id)
+
Configure Blueprint
+Configure target machine characteristics: machine and disk types, network configuration, etc. Returns the modified object.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.BlueprintApi()
+body = cloudendure_api.CloudEndureBlueprint() # CloudEndureBlueprint |
+project_id = 'project_id_example' # str |
+blueprint_id = 'blueprint_id_example' # str |
+
+try:
+ # Configure Blueprint
+ api_response = api_instance.projects_project_id_blueprints_blueprint_id_patch(body, project_id, blueprint_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling BlueprintApi->projects_project_id_blueprints_blueprint_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureBlueprint | ++ | + |
| project_id | +str | ++ | + |
| blueprint_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureBlueprintList projects_project_id_blueprints_get(project_id, offset=offset, limit=limit)
+
List Blueprints
+Returns the list of available blueprints in the project.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.BlueprintApi()
+project_id = 'project_id_example' # str |
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Blueprints
+ api_response = api_instance.projects_project_id_blueprints_get(project_id, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling BlueprintApi->projects_project_id_blueprints_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureBlueprint projects_project_id_blueprints_post(body, project_id)
+
Create Blueprint
+Define the target machine characteristics: machine and disk types, network configuration, etc. There can be only one blueprint per machine per region. Returns the newly created object.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.BlueprintApi()
+body = cloudendure_api.CloudEndureBlueprint() # CloudEndureBlueprint |
+project_id = 'project_id_example' # str |
+
+try:
+ # Create Blueprint
+ api_response = api_instance.projects_project_id_blueprints_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling BlueprintApi->projects_project_id_blueprints_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureBlueprint | ++ | + |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| cloud_credentials_creds_id_regions_get | +GET /cloudCredentials/{credsId}/regions | +List Regions | +
| cloud_credentials_creds_id_regions_region_id_delete | +DELETE /cloudCredentials/{credsId}/regions/{regionId} | +Delete region (VCenter) | +
| cloud_credentials_creds_id_regions_region_id_get | +GET /cloudCredentials/{credsId}/regions/{regionId} | +Get Region | +
| cloud_credentials_creds_id_regions_region_id_patch | +PATCH /cloudCredentials/{credsId}/regions/{regionId} | +Patch region (rename) | +
| clouds_get | +GET /clouds | +List Clouds | +
++CloudEndureRegionsList cloud_credentials_creds_id_regions_get(creds_id, offset=offset, limit=limit)
+
List Regions
+Returns the list of regions these credentials provide access to.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudApi()
+creds_id = 'creds_id_example' # str | UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\".
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Regions
+ api_response = api_instance.cloud_credentials_creds_id_regions_get(creds_id, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudApi->cloud_credentials_creds_id_regions_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| creds_id | +str | +UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\". | ++ |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++cloud_credentials_creds_id_regions_region_id_delete(creds_id, region_id)
+
Delete region (VCenter)
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudApi()
+creds_id = 'creds_id_example' # str | UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\".
+region_id = 'region_id_example' # str |
+
+try:
+ # Delete region (VCenter)
+ api_instance.cloud_credentials_creds_id_regions_region_id_delete(creds_id, region_id)
+except ApiException as e:
+ print("Exception when calling CloudApi->cloud_credentials_creds_id_regions_region_id_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| creds_id | +str | +UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\". | ++ |
| region_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureRegion cloud_credentials_creds_id_regions_region_id_get(creds_id, region_id)
+
Get Region
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudApi()
+creds_id = 'creds_id_example' # str | UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\".
+region_id = 'region_id_example' # str |
+
+try:
+ # Get Region
+ api_response = api_instance.cloud_credentials_creds_id_regions_region_id_get(creds_id, region_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudApi->cloud_credentials_creds_id_regions_region_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| creds_id | +str | +UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\". | ++ |
| region_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureRegion cloud_credentials_creds_id_regions_region_id_patch(body, creds_id, region_id)
+
Patch region (rename)
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudApi()
+body = cloudendure_api.CloudEndureRegion() # CloudEndureRegion |
+creds_id = 'creds_id_example' # str | UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\".
+region_id = 'region_id_example' # str |
+
+try:
+ # Patch region (rename)
+ api_response = api_instance.cloud_credentials_creds_id_regions_region_id_patch(body, creds_id, region_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudApi->cloud_credentials_creds_id_regions_region_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureRegion | ++ | + |
| creds_id | +str | +UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\". | ++ |
| region_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureCloudsList clouds_get(offset=offset, limit=limit)
+
List Clouds
+Returns a list of clouds that can be used with CloudEndure. The roles array determines whether this cloud can be used as source, target, or both.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudApi()
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Clouds
+ api_response = api_instance.clouds_get(offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudApi->clouds_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| cloud_credentials_creds_id_get | +GET /cloudCredentials/{credsId} | +Get Credentials | +
| cloud_credentials_creds_id_patch | +PATCH /cloudCredentials/{credsId} | +Change Credentials | +
| cloud_credentials_get | +GET /cloudCredentials | +List Credentials | +
| cloud_credentials_post | +POST /cloudCredentials | +Create Credentials | +
++CloudEndureCloudCredentials cloud_credentials_creds_id_get(creds_id)
+
Get Credentials
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudCredentialsApi()
+creds_id = 'creds_id_example' # str | UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\".
+
+try:
+ # Get Credentials
+ api_response = api_instance.cloud_credentials_creds_id_get(creds_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudCredentialsApi->cloud_credentials_creds_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| creds_id | +str | +UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\". | ++ |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureCloudCredentials cloud_credentials_creds_id_patch(body, creds_id)
+
Change Credentials
+Changes the cloud credentials. @todo:v15 If the new Cloud Credentials are to a different cloud account (or different cloud), than PATCH should fail with ??? error code and ??? error message. Old v14 behavior: If the these cloud credentials are used with the current replication, and the new credentials are to a different cloud account (or different cloud), all agents will be uninstalled and replication will stop on them.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudCredentialsApi()
+body = cloudendure_api.CloudEndureCloudCredentialsRequest() # CloudEndureCloudCredentialsRequest |
+creds_id = 'creds_id_example' # str | UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\".
+
+try:
+ # Change Credentials
+ api_response = api_instance.cloud_credentials_creds_id_patch(body, creds_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudCredentialsApi->cloud_credentials_creds_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureCloudCredentialsRequest | ++ | + |
| creds_id | +str | +UUID of the credentials to use. In case of on-premise, you should use the null UUID \"00000000-0000-0000-0000-000000000000\". | ++ |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureCloudCredentialsList cloud_credentials_get(offset=offset, limit=limit)
+
List Credentials
+Returns the list of cloudCredentials in the account.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudCredentialsApi()
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Credentials
+ api_response = api_instance.cloud_credentials_get(offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudCredentialsApi->cloud_credentials_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
CloudEndureCloudCredentialsList
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureCloudCredentials cloud_credentials_post(body)
+
Create Credentials
+Provide the credentials with which to access the cloud API. Returns the newly created object.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.CloudCredentialsApi()
+body = cloudendure_api.CloudEndureCloudCredentialsRequest() # CloudEndureCloudCredentialsRequest |
+
+try:
+ # Create Credentials
+ api_response = api_instance.cloud_credentials_post(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling CloudCredentialsApi->cloud_credentials_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureCloudCredentialsRequest | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| invite_token_expiry_minutes | +int | ++ | [optional] | +
| allow_archiving_default_value | +bool | ++ | [optional] | +
| per_account_user_pool | +bool | ++ | [optional] | +
| is_gcp_self_service | +bool | ++ | [optional] | +
| is_dr_trial | +bool | ++ | [optional] | +
| is_arm_self_service | +bool | ++ | [optional] | +
| is_aws_self_service | +bool | ++ | [optional] | +
| saml_settings | +CloudEndureSamlSettings | ++ | [optional] | +
| is_right_sizing_enabled | +bool | ++ | [optional] | +
| default_license_type | +str | ++ | [optional] | +
| max_projects_allowed | +int | ++ | [optional] | +
| ce_admin_properties | +object | +For internal use. | +[optional] | +
| owner_id | +str | +Account Owner (a User) | +[optional] | +
| is_med_one | +bool | ++ | [optional] | +
| id | +str | +UUID of the account | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| id | +str | ++ | [optional] | +
| request_type | +str | ++ | [optional] | +
| str | ++ | [optional] | +|
| request_link | +str | ++ | [optional] | +
| registration_token | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureAccountRequest] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureAccount] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| duration_from_now | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| bool | ++ | [optional] | +|
| is_demo | +bool | ++ | [optional] | +
| windows_converters | +bool | ++ | [optional] | +
| force_reversed_handshake_direction | +bool | ++ | [optional] | +
| no_converters | +bool | ++ | [optional] | +
| vio | +bool | ++ | [optional] | +
| no_cloud | +bool | ++ | [optional] | +
| consistent_snapshot_creation_interval_min | +int | ++ | [optional] | +
| no_public_ips | +bool | ++ | [optional] | +
| daily_pit_number | +int | ++ | [optional] | +
| mtu_size | +int | ++ | [optional] | +
| allow_byol_on_dedicated_instance | +bool | ++ | [optional] | +
| max_converter_volumes | +int | ++ | [optional] | +
| azurearm | +bool | ++ | [optional] | +
| vcenter | +bool | ++ | [optional] | +
| subnet_filter | +str | ++ | [optional] | +
| no_snapshot_considered_lag_milliseconds | +int | ++ | [optional] | +
| no_converters_windows | +bool | ++ | [optional] | +
| disable_replica_creation | +bool | ++ | [optional] | +
| aws | +bool | ++ | [optional] | +
| max_replicator_volumes | +int | ++ | [optional] | +
| allow_recovery_plans | +bool | ++ | [optional] | +
| snapshot_creation_interval_min | +int | ++ | [optional] | +
| snapshot_on_demand_timeout | +int | ++ | [optional] | +
| allow_archiving | +bool | ++ | [optional] | +
| custom_replicator_instance_type | +str | ++ | [optional] | +
| disable_snapshot_on_demand | +bool | ++ | [optional] | +
| disable_install | +bool | ++ | [optional] | +
| hdd | +bool | ++ | [optional] | +
| snapshot_creation_interval_max | +int | ++ | [optional] | +
| ce_admin_properties | +object | +For internal use. | +[optional] | +
| azure | +bool | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureAuditLogEntry] | ++ | [optional] | +
| has_more_results | +bool | +AuditLog API will only return max 1500 entries so this is a way to know if there are more. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| field_name | +str | ++ | [optional] | +
| new_value | +str | ++ | [optional] | +
| old_value | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| username | +str | +username (typically an email) of user who initiated action (in UI or via API) which resulted in this audit log entry being added. | +[optional] | +
| event_name | +str | +Unique event name. One of: - replicationConfigurationChanged - blueprintChanged - ... @todo: complete | +[optional] | +
| participating_machines | +list[object] | +List of machine-identifiers objects. Only present if Audit Log entry relates to one or more machines. | +[optional] | +
| description | +str | +Long-form human-readable description of Audit Log entry. | +[optional] | +
| changed_fields | +list[CloudEndureAuditLogChangedField] | +Map of fields that have been changed and their old an new values. Only present when eventName is replicationConfigurationChanged or blueprintChanged | +[optional] | +
| timestamp | +datetime | +RFC 3339 compliant date-time string of when Audit Log entry was created/ event described by audit log entry happened. | +[optional] | +
| job_id | +str | +ID of Job due to which this log entry was created (only included if log entry is result of a Job) | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| bandwidth_throttling | +int | +Mbps to use for Data Replication (zero means no throttling). | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| iam_role | +str | +AWS only. Possible values can be fetched from the Region object. | +[optional] | +
| scsi_adapter_type | +str | +Currently relevant for vCenter cloud only. Possible values can be fetched from the Region object. | +[optional] | +
| public_ip_action | +str | +Whether to allocate an ephemeral public IP, or not. AS_SUBNET causes CloudEndure to copy this property from the source machine. | +[optional] | +
| machine_name | +str | ++ | [optional] | +
| cpus | +int | +Number of CPUs per per Target machine; Currently relevant for vCenter cloud only; Max value can be fetched from the maxCpusPerMachine property of the Region object. | +[optional] | +
| security_group_i_ds | +list[str] | +AWS only. The security groups that will be applied to the target machine. Possible values can be fetched from the Region object. | +[optional] | +
| run_after_launch | +bool | +AWS only. Whether to power on the launched target machine after launch. True by default. | +[optional] | +
| recommended_private_ip | +str | +The private IP address recommended for use with this machine. | +[optional] | +
| network_interface | +str | ++ | [optional] | +
| id | +str | ++ | [optional] | +
| mb_ram | +int | +MB RAM per Target machine; Currently relevant for vCenter cloud only; Max value can be fetched from the maxMbRamPerMachine property of the Region object. | +[optional] | +
| instance_type | +str | +Possible values can be fetched from the Region object, plus special values \"COPY_ORIGIN\" or \"CUSTOM\" | +[optional] | +
| subnet_i_ds | +list[str] | +AWS only. Configures a subnets in which the instance network interface will take part. Possible values can be fetched from the Region object. | +[optional] | +
| cores_per_cpu | +int | +Number of CPU cores per CPU in Target machine; Currently relevant for vCenter cloud only. | +[optional] | +
| recommended_instance_type | +str | +When instance rightsizing is enabled, the instance type suitable for the source machine's HW | +[optional] | +
| static_ip | +str | +Possible values can be fetched from the Region object. | +[optional] | +
| tags | +list[object] | +AWS only. Tags that will be applied to the target machine. | +[optional] | +
| security_group_action | +str | +How to assign a security group to the target machine. | +[optional] | +
| private_i_ps | +list[str] | ++ | [optional] | +
| tenancy | +str | ++ | [optional] | +
| compute_location_id | +str | +todo | +[optional] | +
| subnets_host_project | +str | +GCP only. Host project for cross project network subnet. | +[optional] | +
| logical_location_id | +str | +vcenter = vmFolder; relates to $ref LogicalLocation | +[optional] | +
| network_adapter_type | +str | +Currently relevant for vCenter cloud only. Possible values can be fetched from the Region object. | +[optional] | +
| byol_on_dedicated_instance | +bool | +specifies whether to use byol windows license if dedicated instance tenancy is selected. | +[optional] | +
| placement_group | +str | +AWS only. Possible values can be fetched from the Region object. | +[optional] | +
| machine_id | +str | ++ | [optional] | +
| region | +str | ++ | [optional] | +
| disks | +list[object] | +AWS only. Target machine disk properties. | +[optional] | +
| private_ip_action | +str | ++ | [optional] | +
| static_ip_action | +str | ++ | [optional] | +
| dedicated_host_identifier | +str | ++ | [optional] | +
| use_shared_ram | +bool | +todo | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureBlueprint] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| id | +str | ++ | [optional] | +
| roles | +list[str] | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| id | +str | ++ | [optional] | +
| public_key | +str | +The public part of the Cloud credentials. For AWS - access key ID; for GCP - user email; for Azure - SHA1 digestion of the certificate file. | +[optional] | +
| account_identifier | +str | +An ID provided by the cloud for the user account. | +[optional] | +
| cloud | +str | ++ | [optional] | +
| name | +str | +An optional (can be empty), user provided, descriptive name. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureCloudCredentials] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| public_key | +str | +The public part of the Cloud credentials. For AWS - The access key ID, For GCP and Azure - N/A. | +[optional] | +
| name | +str | +An optional (can be empty), user provided, descriptive name. | +[optional] | +
| cloud_id | +str | ++ | + |
| private_key | +str | +Cloud credentials secret. For AWS - The secret access key, For GCP - The private key in JSON format, For Azure - The certificate file. | +[optional] | +
| account_identifier | +str | +Cloud account identifier. For AWS - N/A, For GCP - The project ID, For Azure - The subscription ID. | +[optional] | +
| id | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureCloud] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| is_encryption_supported | +bool | ++ | [optional] | +
| location_id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| name | +str | ++ | [optional] | +
| value | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureConfigurations] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| message | +str | ++ | [optional] | +
| code | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| account | +CloudEndureAccount | ++ | [optional] | +
| clouds | +CloudEndureCloudsList | ++ | [optional] | +
| generic_region | +CloudEndureRegion | ++ | [optional] | +
| date_time | +CloudEndureTime | ++ | [optional] | +
| user | +CloudEndureUser | ++ | [optional] | +
| projects | +CloudEndureProjectsList | ++ | [optional] | +
| is_newly_registered | +bool | ++ | [optional] | +
| replication_configurations | +CloudEndureReplicationConfigurationList | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| query | +str | ++ | + |
| machine_i_ds | +list[str] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| machine_id | +str | ++ | + |
| points_in_time | +object | ++ | [optional] | +
| file_path | +str | ++ | + |
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| id | +str | ++ | + |
| date_time | +datetime | ++ | + |
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| count | +int | ++ | + |
| query | +str | ++ | + |
| items | +list[CloudEndureFindFilesResult] | ++ | [optional] | +
| invalid_machine_i_ds | +list[str] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| gcp_project_name | +str | ++ | [optional] | +
| machine_name | +str | ++ | [optional] | +
| number_of_cores | +int | ++ | [optional] | +
| creation_time | +datetime | ++ | [optional] | +
| is_preemptible | +bool | ++ | [optional] | +
| has_gpu | +bool | ++ | [optional] | +
| machine_id | +str | ++ | [optional] | +
| ce_project_name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| saml_redirect | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| status | +str | ++ | [optional] | +
| message | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| status | +str | ++ | [optional] | +
| participating_machines | +list[str] | ++ | [optional] | +
| log | +list[object] | ++ | [optional] | +
| type | +str | +todo explian that cleanup is also for restore servers | +[optional] | +
| end_date_time | +datetime | ++ | [optional] | +
| creation_date_time | +datetime | ++ | [optional] | +
| id | +str | ++ | [optional] | +
| initiated_by | +str | +username of user who initiated the job | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureJob] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[object] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureMachineAndPointInTime] | ++ | [optional] | +
| launch_type | +str | ++ | + |
| debug_scripts | +object | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| count | +int | +The total number of licenses. | +[optional] | +
| duration_from_start_of_use | +str | +Validity period for a a single license from the time of agent installation. | +[optional] | +
| used | +int | +How many licenses have already been consumed. | +[optional] | +
| features | +CloudEndureLicenseFeatures | ++ | [optional] | +
| expiration_date_time | +datetime | ++ | [optional] | +
| ce_admin_properties | +object | +For internal use. | +[optional] | +
| type | +str | +License type. DR licenses can be moved from one machine to another. Migration licenses are consumed upon installation. | +[optional] | +
| id | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| pit | +bool | ++ | [optional] | +
| dr_tier2 | +bool | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureLicense] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| username | +str | ++ | [optional] | +
| is_account_owner | +bool | ++ | [optional] | +
| state | +str | ++ | [optional] | +
| version | +str | ++ | [optional] | +
| account_uuid | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureListUsersResult] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| location_id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| source_properties | +object | +Source machine properties. | +[optional] | +
| replication_info | +object | +Detailed information on the state of replication. | +[optional] | +
| license | +object | +Detailed machine license consumption information. | +[optional] | +
| tags | +list[str] | ++ | [optional] | +
| restore_servers | +list[str] | +todo restoreServer ids | +[optional] | +
| from_point_in_time | +CloudEndurePointInTime | ++ | [optional] | +
| replication_status | +str | +Is replication started, paused or stopped | +[optional] | +
| replica | +str | +The ID of the target machine that has been previously launched, if such exists. | +[optional] | +
| id | +str | ++ | [optional] | +
| replication_configuration | +CloudEndureMachineReplicationConfiguration | ++ | [optional] | +
| life_cycle | +object | +Detailed machine lifecycle information. | +[optional] | +
| is_agent_installed | +bool | +Whether a CloudEndure agent is currently installed on this machine. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| machine_id | +str | ++ | + |
| point_in_time_id | +str | ++ | [optional] | +
| file_path | +str | ++ | + |
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| machine_id | +str | +A source machine to launch a target machine for. | ++ |
| point_in_time_id | +str | +The ID of the pointInTime to launch a target machine from. If omitted, CloudEndure will use the latest pointInTime. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| volume_encryption_key | +str | +AWS only. ARN to private key for Volume Encryption. Possible values can be fetched from the Region object. | +[optional] | +
| replication_tags | +list[object] | +AWS only. Tags that will be applied to every cloud resource created in the CloudEndure Staging Area. | +[optional] | +
| subnet_host_project | +str | +GCP only. Host project of cross project network subnet. | +[optional] | +
| replication_server_type | +str | ++ | [optional] | +
| compute_location_id | +str | +todo vcenter only | +[optional] | +
| subnet_id | +str | +Subnet where replication servers will be created. Possible values can be fetched from the Region object. | +[optional] | +
| logical_location_id | +str | +vcenter = vmFolder | +[optional] | +
| bandwidth_throttling | +int | +Mbps to use for Data Replication (zero means no throttling). | +[optional] | +
| storage_location_id | +str | +@todo backend creates cloudendure bla bla storage account upon need (empty string). | +[optional] | +
| use_dedicated_server | +bool | ++ | [optional] | +
| zone | +str | +Relevant for GCP and Azure ARM. The Zone to replicate into. | +[optional] | +
| replicator_security_group_i_ds | +list[str] | +AWS only. The security groups that will be applied to the replication servers. Possible values can be fetched from the Region object. | +[optional] | +
| use_private_ip | +bool | +Should the CloudEndure agent access the replication server using its private IP address. | +[optional] | +
| proxy_url | +str | +The full URI for a proxy (schema, username, password, domain, port) if required for the CloudEndure agent. | +[optional] | +
| volume_encryption_allowed | +bool | +todo AWS only... not relevant for Backup Projects because EBS is not used | +[optional] | +
| archiving_enabled | +bool | ++ | [optional] | +
| object_storage_location | +str | +bucket in aws | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| credits | +int | +Mbps to use for Data Replication (zero means no throttling). | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| credits | +int | +time to throttle the machine in seconds | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureMachine] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureMachine] | ++ | [optional] | +
| job | +CloudEndureJob | ++ | [optional] | +
| invalid_machine_i_ds | +list[str] | +The IDs of the machines for which the operation failed. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| subnet_id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| private_ip | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| id | +str | ++ | [optional] | +
| date_time | +datetime | +Timestamp for this Recovery Point. A NULL value signifies there is no later point available. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndurePointInTime] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| target_cloud_id | +str | ++ | [optional] | +
| agent_installation_token | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| users_i_ds | +list[str] | +todo empty array unless AO or ce admin | +[optional] | +
| type | +str | ++ | [optional] | +
| replication_reversed | +bool | ++ | [optional] | +
| source_cloud_credentials_id | +str | ++ | [optional] | +
| cloud_credentials_i_ds | +list[str] | +The IDs of the cloud credentials to use (array of one). | +[optional] | +
| source_region | +str | +The ID of the region to use as source. | +[optional] | +
| licenses_i_ds | +list[str] | +The IDs of the licenses associated with this project (array of one). | +[optional] | +
| ce_admin_properties | +object | +For internal use. | +[optional] | +
| replication_configuration | +str | +The ID of the replication configuration object to use (corresponding to the ones available in /projects/{projectId}/replicationConfigurations). | +[optional] | +
| source_cloud_id | +str | ++ | [optional] | +
| id | +str | ++ | [optional] | +
| features | +object | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | [optional] | +
| points_in_time_total_bytes | +int | ++ | [optional] | +
| running_machines_total_bytes | +int | ++ | [optional] | +
| working_storage | +object | ++ | [optional] | +
| calculation_date_time | +datetime | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[object] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureProject] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| steps | +CloudEndureRecoveryPlanSteps | ++ | [optional] | +
| id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureRecoveryPlan] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| machine_i_ds | +list[str] | ++ | [optional] | +
| wait_before | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureRecoveryPlanStep] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| subnets | +list[CloudEndureSubnet] | ++ | [optional] | +
| placement_groups | +list[str] | ++ | [optional] | +
| scsi_adapter_types | +list[str] | +todo | +[optional] | +
| instance_types | +list[str] | ++ | [optional] | +
| zones | +list[str] | ++ | [optional] | +
| volume_encryption_keys | +list[str] | ++ | [optional] | +
| cloud | +str | ++ | [optional] | +
| security_groups | +list[CloudEndureSecurityGroup] | ++ | [optional] | +
| logical_locations | +list[CloudEndureLogicalLocation] | ++ | [optional] | +
| static_ips | +list[str] | ++ | [optional] | +
| max_cpus_per_machine | +int | +Maximum CPUs per per Target machine (currently relevant for vCenter cloud only) | +[optional] | +
| network_interfaces | +list[CloudEndureNetworkInterface] | ++ | [optional] | +
| compute_locations | +list[CloudEndureComputeLocation] | +Compute location (e.g. vCenter Host) | +[optional] | +
| name | +str | ++ | [optional] | +
| storage_locations | +list[CloudEndureStorageLocation] | +Storage location (e.g. Azure Storage Account, vCenter Data Store) | +[optional] | +
| iam_roles | +list[str] | ++ | [optional] | +
| id | +str | ++ | [optional] | +
| max_cores_per_machine_cpu | +int | +Maximum CPU cores per CPU in Target machines (currently relevant for vCenter cloud only) | +[optional] | +
| dedicated_hosts | +list[str] | ++ | [optional] | +
| network_adapter_types | +list[str] | +todo | +[optional] | +
| max_mb_ram_per_machine | +int | +Maximum MB RAM per Target machine (currently relevant for vCenter cloud only) | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureRegion] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| machine | +str | +The ID of the source machine for this target machine. | +[optional] | +
| cloud_endure_creation_date_time | +datetime | +Timestamp for launching this target machine. | +[optional] | +
| name | +str | +Target machine name in the target environment. | +[optional] | +
| point_in_time | +str | +The ID of the pointInTime object from which this target machine was created. | +[optional] | +
| machine_cloud_state | +str | +Target machine state in the target environment. | +[optional] | +
| public_ips | +list[str] | +Static (non-ephemral) public IPs. On some clouds this also includes ephemeral IPs. | +[optional] | +
| region_id | +str | +The ID of the region where this target machine has been launched. | +[optional] | +
| id | +str | ++ | [optional] | +
| machine_cloud_id | +str | +Target machine ID in the target environment. | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| volume_encryption_key | +str | +AWS only. ARN to private key for Volume Encryption. Possible values can be fetched from the Region object. | +[optional] | +
| replication_tags | +list[object] | +AWS only. Tags that will be applied to every cloud resource created in the CloudEndure Staging Area. | +[optional] | +
| subnet_host_project | +str | +GCP only. Host project of cross project network subnet. | +[optional] | +
| replication_server_type | +str | ++ | [optional] | +
| compute_location_id | +str | +todo vcenter only | +[optional] | +
| cloud_credentials | +str | +The ID for the cloudCredentials object containing the credentials to be used for accessing the target cloud. | +[optional] | +
| subnet_id | +str | +Subnet where replication servers will be created. Possible values can be fetched from the Region object. | +[optional] | +
| logical_location_id | +str | +vcenter = vmFolder | +[optional] | +
| bandwidth_throttling | +int | +Mbps to use for Data Replication (zero means no throttling). | +[optional] | +
| storage_location_id | +str | +@todo backend creates cloudendure bla bla storage account upon need (empty string). | +[optional] | +
| use_dedicated_server | +bool | ++ | [optional] | +
| zone | +str | +Relevant for GCP and Azure ARM. The Zone to replicate into. | +[optional] | +
| replicator_security_group_i_ds | +list[str] | +AWS only. The security groups that will be applied to the replication servers. Possible values can be fetched from the Region object. | +[optional] | +
| use_private_ip | +bool | +Should the CloudEndure agent access the replication server using its private IP address. | +[optional] | +
| region | +str | ++ | [optional] | +
| id | +str | ++ | [optional] | +
| proxy_url | +str | +The full URI for a proxy (schema, username, password, domain, port) if required for the CloudEndure agent. | +[optional] | +
| volume_encryption_allowed | +bool | +todo | +[optional] | +
| archiving_enabled | +bool | ++ | [optional] | +
| object_storage_location | +str | +bucket in aws | +[optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureReplicationConfiguration] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| volumes | +list[object] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureMachineAndPathAndPointInTime] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| identity_provider_certificate | +str | ++ | [optional] | +
| identity_provider_url | +str | ++ | [optional] | +
| identity_provider_id | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| network_id | +str | ++ | [optional] | +
| security_group_id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| location_id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| subnet_id | +str | ++ | [optional] | +
| network_id | +str | ++ | [optional] | +
| name | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| date_time | +datetime | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| result | +object | ++ | [optional] | +
| error | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| sleep | +int | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| start_of_use_date_time | +datetime | ++ | [optional] | +
| cloud_id | +str | +The ID in the cloud | +[optional] | +
| name | +str | +The name of the machine. | +[optional] | +
| machine_id | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureUsage] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| username | +str | ++ | [optional] | +
| status | +str | ++ | [optional] | +
| account | +str | ++ | [optional] | +
| roles | +list[str] | ++ | [optional] | +
| settings | +object | ++ | [optional] | +
| api_token | +str | ++ | [optional] | +
| has_password | +bool | ++ | [optional] | +
| terms_accepted | +bool | +todo one-way; cannot be set at time of POST | +[optional] | +
| id | +str | ++ | [optional] | +
| self_link | +str | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| n_protected_machines | +int | ++ | [optional] | +
| project_name | +str | ++ | [optional] | +
| is_activated | +bool | ++ | [optional] | +
| n_license_usages | +int | ++ | [optional] | +
| gcp_machines_finance_data | +object | ++ | [optional] | +
| total_tested_or_cutover | +int | ++ | [optional] | +
| owner_name | +str | ++ | [optional] | +
| n_lagging_machines | +int | ++ | [optional] | +
| n_active_target_machines | +int | ++ | [optional] | +
| n_test_machines | +int | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureUserReport] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[object] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| items | +list[CloudEndureUser] | ++ | [optional] | +
| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| netmask | +str | ++ | [optional] | +
| ip_address | +str | ++ | [optional] | +
All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| accounts_account_id_access_get | +GET /accounts/{accountId}/access | +get a temporary token by email | +
| extended_account_info_get | +GET /extendedAccountInfo | +Returns the extended current account information. | +
| projects_assign_users_post | +POST /projects/assignUsers | +todo | +
| projects_project_id_audit_log_get | +GET /projects/{projectId}/auditLog | +Get audit log | +
| projects_project_id_storage_get | +GET /projects/{projectId}/storage | +project's storage | +
| projects_remove_users_post | +POST /projects/removeUsers | +todo | +
| replace_api_token_post | +POST /replaceApiToken | +Replaces API token | +
| set_password_post | +POST /setPassword | +Set password for invited user | +
| users_assign_roles_post | +POST /users/assignRoles | +Add roles to users | +
| users_post | +POST /users | +Create a new User | +
| users_revoke_roles_post | +POST /users/revokeRoles | +Add roles to users | +
++object accounts_account_id_access_get(account_id, username)
+
get a temporary token by email
+get a temporary token by email. Available for account owner when SSO is used
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+account_id = 'account_id_example' # str |
+username = 'username_example' # str |
+
+try:
+ # get a temporary token by email
+ api_response = api_instance.accounts_account_id_access_get(account_id, username)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->accounts_account_id_access_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| account_id | +str | ++ | + |
| username | +str | ++ | + |
object
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureExtendedAccountInfo extended_account_info_get()
+
Returns the extended current account information.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+
+try:
+ # Returns the extended current account information.
+ api_response = api_instance.extended_account_info_get()
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->extended_account_info_get: %s\n" % e)
+
+
+This endpoint does not need any parameter.
+CloudEndureExtendedAccountInfo
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_assign_users_post(body)
+
todo
+todo
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+body = cloudendure_api.CloudEndureProjectsAndUsers() # CloudEndureProjectsAndUsers |
+
+try:
+ # todo
+ api_instance.projects_assign_users_post(body)
+except ApiException as e:
+ print("Exception when calling DefaultApi->projects_assign_users_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureProjectsAndUsers | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureAuditLog projects_project_id_audit_log_get(project_id, limit=limit, from_date_time=from_date_time, to_date_time=to_date_time, format=format)
+
Get audit log
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+project_id = 'project_id_example' # str |
+limit = 56 # int | A number specifying how many entries to return. (optional)
+from_date_time = '2013-10-20T19:20:30+01:00' # datetime | Used to limit the response to a specific date range. Must be used in conjunction with toDateTime param. (optional)
+to_date_time = '2013-10-20T19:20:30+01:00' # datetime | Used to limit the response to a specific date range. Must be used in conjunction with fromDateTime param. (optional)
+format = 'format_example' # str | (optional)
+
+try:
+ # Get audit log
+ api_response = api_instance.projects_project_id_audit_log_get(project_id, limit=limit, from_date_time=from_date_time, to_date_time=to_date_time, format=format)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->projects_project_id_audit_log_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
| from_date_time | +datetime | +Used to limit the response to a specific date range. Must be used in conjunction with toDateTime param. | +[optional] | +
| to_date_time | +datetime | +Used to limit the response to a specific date range. Must be used in conjunction with fromDateTime param. | +[optional] | +
| format | +str | ++ | [optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureProjectStorage projects_project_id_storage_get(project_id)
+
project's storage
+get project's storage usage (vCenter only)
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+project_id = 'project_id_example' # str |
+
+try:
+ # project's storage
+ api_response = api_instance.projects_project_id_storage_get(project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->projects_project_id_storage_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_remove_users_post(body)
+
todo
+todo
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+body = cloudendure_api.CloudEndureProjectsAndUsers() # CloudEndureProjectsAndUsers |
+
+try:
+ # todo
+ api_instance.projects_remove_users_post(body)
+except ApiException as e:
+ print("Exception when calling DefaultApi->projects_remove_users_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureProjectsAndUsers | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++object replace_api_token_post()
+
Replaces API token
+Replaces API token
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+
+try:
+ # Replaces API token
+ api_response = api_instance.replace_api_token_post()
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->replace_api_token_post: %s\n" % e)
+
+
+This endpoint does not need any parameter.
+object
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++set_password_post(body)
+
Set password for invited user
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+body = NULL # object | set password token and new password
+
+try:
+ # Set password for invited user
+ api_instance.set_password_post(body)
+except ApiException as e:
+ print("Exception when calling DefaultApi->set_password_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +set password token and new password | ++ |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureUsersList users_assign_roles_post(body)
+
Add roles to users
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+body = cloudendure_api.CloudEndureUsersAndRoles() # CloudEndureUsersAndRoles |
+
+try:
+ # Add roles to users
+ api_response = api_instance.users_assign_roles_post(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->users_assign_roles_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureUsersAndRoles | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureUser users_post(body)
+
Create a new User
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+body = NULL # object |
+
+try:
+ # Create a new User
+ api_response = api_instance.users_post(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->users_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureUsersList users_revoke_roles_post(body)
+
Add roles to users
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.DefaultApi()
+body = cloudendure_api.CloudEndureUsersAndRoles() # CloudEndureUsersAndRoles |
+
+try:
+ # Add roles to users
+ api_response = api_instance.users_revoke_roles_post(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling DefaultApi->users_revoke_roles_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureUsersAndRoles | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| licenses_get | +GET /licenses | +List Licenses | +
| licenses_license_id_get | +GET /licenses/{licenseId} | +Get License | +
++CloudEndureLicenseList licenses_get(offset=offset, limit=limit)
+
List Licenses
+Returns the list of licenses currently associated with this user.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.LicensingApi()
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Licenses
+ api_response = api_instance.licenses_get(offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling LicensingApi->licenses_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureLicense licenses_license_id_get(license_id)
+
Get License
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.LicensingApi()
+license_id = 'license_id_example' # str |
+
+try:
+ # Get License
+ api_response = api_instance.licenses_license_id_get(license_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling LicensingApi->licenses_license_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| license_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| projects_project_id_machines_delete | +DELETE /projects/{projectId}/machines | +Uninstall agent | +
| projects_project_id_machines_get | +GET /projects/{projectId}/machines | +List Machines | +
| projects_project_id_machines_machine_id_get | +GET /projects/{projectId}/machines/{machineId} | +Get a specific machine. | +
| projects_project_id_machines_machine_id_patch | +PATCH /projects/{projectId}/machines/{machineId} | +Update a machine. Accepts only Launch time updates. | +
| projects_project_id_machines_patch | +PATCH /projects/{projectId}/machines | +Batch-update multiple machines | +
| projects_project_id_replicas_replica_id_get | +GET /projects/{projectId}/replicas/{replicaId} | +Get Target Machine | +
++projects_project_id_machines_delete(body, project_id)
+
Uninstall agent
+Stops replication and removes the cloudendure agent from the specified machines. All cloud artifacts associated with those machines with the exception of launched target machines are deleted.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.MachinesApi()
+body = NULL # object | The list of machine IDs to remove from the CloudEndure service.
+project_id = 'project_id_example' # str |
+
+try:
+ # Uninstall agent
+ api_instance.projects_project_id_machines_delete(body, project_id)
+except ApiException as e:
+ print("Exception when calling MachinesApi->projects_project_id_machines_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +The list of machine IDs to remove from the CloudEndure service. | ++ |
| project_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachinesList projects_project_id_machines_get(project_id, offset=offset, limit=limit, all=all, types=types)
+
List Machines
+Returns the list of all source machines in the Project (i.e. machines that have an Agent installed).
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.MachinesApi()
+project_id = 'project_id_example' # str |
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+all = true # bool | When set to false, returns only currently replicating machines. When set to true, returns all machines in the project regardless of replications status. machines are consuming/ have consumed licenses. Note that some license types are transferable and therefore once you remove the and set to true false, returns only currently replicating machines. When set to true, returns all machines in the project regardless of replications status. (optional)
+types = 'types_example' # str | Use this url query param to control which machines are returned when doing GET. If you do not include the \\\"types\\\" query param, you will only get source machines (optional)
+
+try:
+ # List Machines
+ api_response = api_instance.projects_project_id_machines_get(project_id, offset=offset, limit=limit, all=all, types=types)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling MachinesApi->projects_project_id_machines_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
| all | +bool | +When set to false, returns only currently replicating machines. When set to true, returns all machines in the project regardless of replications status. machines are consuming/ have consumed licenses. Note that some license types are transferable and therefore once you remove the and set to true false, returns only currently replicating machines. When set to true, returns all machines in the project regardless of replications status. | +[optional] | +
| types | +str | +Use this url query param to control which machines are returned when doing GET. If you do not include the \\"types\\" query param, you will only get source machines | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachine projects_project_id_machines_machine_id_get(project_id, machine_id)
+
Get a specific machine.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.MachinesApi()
+project_id = 'project_id_example' # str |
+machine_id = 'machine_id_example' # str |
+
+try:
+ # Get a specific machine.
+ api_response = api_instance.projects_project_id_machines_machine_id_get(project_id, machine_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling MachinesApi->projects_project_id_machines_machine_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| machine_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachine projects_project_id_machines_machine_id_patch(body, project_id, machine_id)
+
Update a machine. Accepts only Launch time updates.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.MachinesApi()
+body = cloudendure_api.CloudEndureMachine() # CloudEndureMachine |
+project_id = 'project_id_example' # str |
+machine_id = 'machine_id_example' # str |
+
+try:
+ # Update a machine. Accepts only Launch time updates.
+ api_response = api_instance.projects_project_id_machines_machine_id_patch(body, project_id, machine_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling MachinesApi->projects_project_id_machines_machine_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureMachine | ++ | + |
| project_id | +str | ++ | + |
| machine_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureMachinesList projects_project_id_machines_patch(body, project_id)
+
Batch-update multiple machines
+todo must allow update of tags, update of replicationConfiguration; may allow update of launch times
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.MachinesApi()
+body = cloudendure_api.CloudEndureMachinesList() # CloudEndureMachinesList |
+project_id = 'project_id_example' # str |
+
+try:
+ # Batch-update multiple machines
+ api_response = api_instance.projects_project_id_machines_patch(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling MachinesApi->projects_project_id_machines_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureMachinesList | ++ | + |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureReplica projects_project_id_replicas_replica_id_get(project_id, replica_id)
+
Get Target Machine
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.MachinesApi()
+project_id = 'project_id_example' # str |
+replica_id = 'replica_id_example' # str |
+
+try:
+ # Get Target Machine
+ api_response = api_instance.projects_project_id_replicas_replica_id_get(project_id, replica_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling MachinesApi->projects_project_id_replicas_replica_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| replica_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| projects_get | +GET /projects | +List Projects | +
| projects_post | +POST /projects | +Create Project | +
| projects_project_id_delete | +DELETE /projects/{projectId} | +Delete Project and all sub-resources including cloud assets other than launched target machines | +
| projects_project_id_get | +GET /projects/{projectId} | +Get Project | +
| projects_project_id_patch | +PATCH /projects/{projectId} | +Update Project (including partial update) | +
| projects_project_id_tags_get | +GET /projects/{projectId}/tags | +Gets all instance tags of all machines in the project. | +
++CloudEndureProjectsList projects_get(offset=offset, limit=limit)
+
List Projects
+Returns the list of projects defined in this account.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ProjectApi()
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Projects
+ api_response = api_instance.projects_get(offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ProjectApi->projects_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureProject projects_post(body)
+
Create Project
+Create project
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ProjectApi()
+body = cloudendure_api.CloudEndureProject() # CloudEndureProject |
+
+try:
+ # Create Project
+ api_response = api_instance.projects_post(body)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ProjectApi->projects_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureProject | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_project_id_delete(project_id)
+
Delete Project and all sub-resources including cloud assets other than launched target machines
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ProjectApi()
+project_id = 'project_id_example' # str |
+
+try:
+ # Delete Project and all sub-resources including cloud assets other than launched target machines
+ api_instance.projects_project_id_delete(project_id)
+except ApiException as e:
+ print("Exception when calling ProjectApi->projects_project_id_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureProject projects_project_id_get(project_id)
+
Get Project
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ProjectApi()
+project_id = 'project_id_example' # str |
+
+try:
+ # Get Project
+ api_response = api_instance.projects_project_id_get(project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ProjectApi->projects_project_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureProject projects_project_id_patch(body, project_id)
+
Update Project (including partial update)
+Set project properties including Data Replication source location and replicationConfiguration to use.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ProjectApi()
+body = cloudendure_api.CloudEndureProject() # CloudEndureProject |
+project_id = 'project_id_example' # str |
+
+try:
+ # Update Project (including partial update)
+ api_response = api_instance.projects_project_id_patch(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ProjectApi->projects_project_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureProject | ++ | + |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++object projects_project_id_tags_get(project_id, offset=offset, limit=limit)
+
Gets all instance tags of all machines in the project.
+Returns all instance tags of all machines in the project.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ProjectApi()
+project_id = 'project_id_example' # str |
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # Gets all instance tags of all machines in the project.
+ api_response = api_instance.projects_project_id_tags_get(project_id, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ProjectApi->projects_project_id_tags_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
object
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| projects_project_id_recovery_plans_get | +GET /projects/{projectId}/recoveryPlans | +Gets all recovery plans for the project. | +
| projects_project_id_recovery_plans_post | +POST /projects/{projectId}/recoveryPlans | +Creates a new recovery plan. | +
| projects_project_id_recovery_plans_recovery_plan_id_delete | +DELETE /projects/{projectId}/recoveryPlans/{recoveryPlanId} | +Deletes a recovery plan. | +
| projects_project_id_recovery_plans_recovery_plan_id_get | +GET /projects/{projectId}/recoveryPlans/{recoveryPlanId} | +Gets a recovery plan. | +
| projects_project_id_recovery_plans_recovery_plan_id_patch | +PATCH /projects/{projectId}/recoveryPlans/{recoveryPlanId} | +Updates a new recovery plan. | +
| projects_project_id_run_recovery_plan_post | +POST /projects/{projectId}/runRecoveryPlan | +Launch a recovery plan. | +
++CloudEndureRecoveryPlanList projects_project_id_recovery_plans_get(project_id)
+
Gets all recovery plans for the project.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.RecoveryPlansApi()
+project_id = 'project_id_example' # str |
+
+try:
+ # Gets all recovery plans for the project.
+ api_response = api_instance.projects_project_id_recovery_plans_get(project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling RecoveryPlansApi->projects_project_id_recovery_plans_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureRecoveryPlan projects_project_id_recovery_plans_post(body, project_id)
+
Creates a new recovery plan.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.RecoveryPlansApi()
+body = cloudendure_api.CloudEndureRecoveryPlan() # CloudEndureRecoveryPlan | Recovery Plan to create
+project_id = 'project_id_example' # str |
+
+try:
+ # Creates a new recovery plan.
+ api_response = api_instance.projects_project_id_recovery_plans_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling RecoveryPlansApi->projects_project_id_recovery_plans_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureRecoveryPlan | +Recovery Plan to create | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_project_id_recovery_plans_recovery_plan_id_delete(project_id, recovery_plan_id)
+
Deletes a recovery plan.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.RecoveryPlansApi()
+project_id = 'project_id_example' # str |
+recovery_plan_id = 'recovery_plan_id_example' # str |
+
+try:
+ # Deletes a recovery plan.
+ api_instance.projects_project_id_recovery_plans_recovery_plan_id_delete(project_id, recovery_plan_id)
+except ApiException as e:
+ print("Exception when calling RecoveryPlansApi->projects_project_id_recovery_plans_recovery_plan_id_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| recovery_plan_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureRecoveryPlan projects_project_id_recovery_plans_recovery_plan_id_get(project_id, recovery_plan_id)
+
Gets a recovery plan.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.RecoveryPlansApi()
+project_id = 'project_id_example' # str |
+recovery_plan_id = 'recovery_plan_id_example' # str |
+
+try:
+ # Gets a recovery plan.
+ api_response = api_instance.projects_project_id_recovery_plans_recovery_plan_id_get(project_id, recovery_plan_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling RecoveryPlansApi->projects_project_id_recovery_plans_recovery_plan_id_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| recovery_plan_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureRecoveryPlan projects_project_id_recovery_plans_recovery_plan_id_patch(body, project_id, recovery_plan_id)
+
Updates a new recovery plan.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.RecoveryPlansApi()
+body = cloudendure_api.CloudEndureRecoveryPlan() # CloudEndureRecoveryPlan | Recovery Plan to create
+project_id = 'project_id_example' # str |
+recovery_plan_id = 'recovery_plan_id_example' # str |
+
+try:
+ # Updates a new recovery plan.
+ api_response = api_instance.projects_project_id_recovery_plans_recovery_plan_id_patch(body, project_id, recovery_plan_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling RecoveryPlansApi->projects_project_id_recovery_plans_recovery_plan_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureRecoveryPlan | +Recovery Plan to create | ++ |
| project_id | +str | ++ | + |
| recovery_plan_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureJob projects_project_id_run_recovery_plan_post(body, project_id)
+
Launch a recovery plan.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.RecoveryPlansApi()
+body = NULL # object | Recovery Plan to create
+project_id = 'project_id_example' # str |
+
+try:
+ # Launch a recovery plan.
+ api_response = api_instance.projects_project_id_run_recovery_plan_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling RecoveryPlansApi->projects_project_id_run_recovery_plan_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | +Recovery Plan to create | ++ |
| project_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| projects_project_id_machines_machine_id_bandwidth_throttling_get | +GET /projects/{projectId}/machines/{machineId}/bandwidthThrottling | +Get value of network bandwidth throttling setting for Machine | +
| projects_project_id_machines_machine_id_bandwidth_throttling_patch | +PATCH /projects/{projectId}/machines/{machineId}/bandwidthThrottling | +Set value of network bandwidth throttling setting for Machine | +
| projects_project_id_machines_machine_id_delete | +DELETE /projects/{projectId}/machines/{machineId} | +Uninstall agent | +
| projects_project_id_machines_machine_id_pointsintime_get | +GET /projects/{projectId}/machines/{machineId}/pointsintime | +List Available Points-in-time | +
| projects_project_id_replication_configurations_get | +GET /projects/{projectId}/replicationConfigurations | +List Replication Configurations | +
| projects_project_id_replication_configurations_post | +POST /projects/{projectId}/replicationConfigurations | +Create Replication Configuration | +
| projects_project_id_replication_configurations_replication_configuration_id_patch | +PATCH /projects/{projectId}/replicationConfigurations/{replicationConfigurationId} | +Modify Replication Configuration | +
++CloudEndureBandwidthThrottling projects_project_id_machines_machine_id_bandwidth_throttling_get(project_id, machine_id)
+
Get value of network bandwidth throttling setting for Machine
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+project_id = 'project_id_example' # str |
+machine_id = 'machine_id_example' # str |
+
+try:
+ # Get value of network bandwidth throttling setting for Machine
+ api_response = api_instance.projects_project_id_machines_machine_id_bandwidth_throttling_get(project_id, machine_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_machines_machine_id_bandwidth_throttling_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| machine_id | +str | ++ | + |
CloudEndureBandwidthThrottling
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureBandwidthThrottling projects_project_id_machines_machine_id_bandwidth_throttling_patch(body, project_id, machine_id)
+
Set value of network bandwidth throttling setting for Machine
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+body = cloudendure_api.CloudEndureBandwidthThrottling() # CloudEndureBandwidthThrottling |
+project_id = 'project_id_example' # str |
+machine_id = 'machine_id_example' # str |
+
+try:
+ # Set value of network bandwidth throttling setting for Machine
+ api_response = api_instance.projects_project_id_machines_machine_id_bandwidth_throttling_patch(body, project_id, machine_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_machines_machine_id_bandwidth_throttling_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureBandwidthThrottling | ++ | + |
| project_id | +str | ++ | + |
| machine_id | +str | ++ | + |
CloudEndureBandwidthThrottling
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++projects_project_id_machines_machine_id_delete(project_id, machine_id)
+
Uninstall agent
+Stops replication and removes the cloudendure agent from this machine. All cloud artifacts associated with those machines with the exception of launched target machine are deleted.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+project_id = 'project_id_example' # str |
+machine_id = 'machine_id_example' # str |
+
+try:
+ # Uninstall agent
+ api_instance.projects_project_id_machines_machine_id_delete(project_id, machine_id)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_machines_machine_id_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| machine_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndurePointInTimeList projects_project_id_machines_machine_id_pointsintime_get(project_id, machine_id, offset=offset, limit=limit)
+
List Available Points-in-time
+Returns the list of available recovery points for this machine.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+project_id = 'project_id_example' # str |
+machine_id = 'machine_id_example' # str |
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Available Points-in-time
+ api_response = api_instance.projects_project_id_machines_machine_id_pointsintime_get(project_id, machine_id, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_machines_machine_id_pointsintime_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| machine_id | +str | ++ | + |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureReplicationConfigurationList projects_project_id_replication_configurations_get(project_id, offset=offset, limit=limit)
+
List Replication Configurations
+Returns the list of replication configuration objects defined in this project.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+project_id = 'project_id_example' # str |
+offset = 56 # int | With which item to start (0 based). (optional)
+limit = 56 # int | A number specifying how many entries to return. (optional)
+
+try:
+ # List Replication Configurations
+ api_response = api_instance.projects_project_id_replication_configurations_get(project_id, offset=offset, limit=limit)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_replication_configurations_get: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| project_id | +str | ++ | + |
| offset | +int | +With which item to start (0 based). | +[optional] | +
| limit | +int | +A number specifying how many entries to return. | +[optional] | +
CloudEndureReplicationConfigurationList
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureReplicationConfiguration projects_project_id_replication_configurations_post(body, project_id)
+
Create Replication Configuration
+Control Data Replication parameters such as target cloud credentials, Staging Area and replication network configuration. A single configuration can exist per target region. Returns the newly created object.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+body = cloudendure_api.CloudEndureReplicationConfiguration() # CloudEndureReplicationConfiguration |
+project_id = 'project_id_example' # str |
+
+try:
+ # Create Replication Configuration
+ api_response = api_instance.projects_project_id_replication_configurations_post(body, project_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_replication_configurations_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureReplicationConfiguration | ++ | + |
| project_id | +str | ++ | + |
CloudEndureReplicationConfiguration
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureReplicationConfiguration projects_project_id_replication_configurations_replication_configuration_id_patch(body, project_id, replication_configuration_id)
+
Modify Replication Configuration
+Modifying volumeEncryptionKey or modifying cloudCredentials to ones matching a different cloud account will result in replication restarting from initial sync. Returns the modified object.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.ReplicationApi()
+body = cloudendure_api.CloudEndureReplicationConfiguration() # CloudEndureReplicationConfiguration |
+project_id = 'project_id_example' # str |
+replication_configuration_id = 'replication_configuration_id_example' # str |
+
+try:
+ # Modify Replication Configuration
+ api_response = api_instance.projects_project_id_replication_configurations_replication_configuration_id_patch(body, project_id, replication_configuration_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling ReplicationApi->projects_project_id_replication_configurations_replication_configuration_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureReplicationConfiguration | ++ | + |
| project_id | +str | ++ | + |
| replication_configuration_id | +str | ++ | + |
CloudEndureReplicationConfiguration
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +All URIs are relative to https://console.cloudendure.com/api/latest
+| Method | +HTTP request | +Description | +
|---|---|---|
| change_password_post | +POST /changePassword | +Change Password | +
| me_get | +GET /me | +Me | +
| users_user_id_delete | +DELETE /users/{userId} | +Delete a User | +
| users_user_id_patch | +PATCH /users/{userId} | +Modify user settings | +
++change_password_post(body)
+
Change Password
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.UserApi()
+body = NULL # object |
+
+try:
+ # Change Password
+ api_instance.change_password_post(body)
+except ApiException as e:
+ print("Exception when calling UserApi->change_password_post: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +object | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureUser me_get()
+
Me
+Provides user configuration information for the currently logged in user.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.UserApi()
+
+try:
+ # Me
+ api_response = api_instance.me_get()
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling UserApi->me_get: %s\n" % e)
+
+
+This endpoint does not need any parameter.
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++users_user_id_delete(user_id)
+
Delete a User
+todo
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.UserApi()
+user_id = 'user_id_example' # str |
+
+try:
+ # Delete a User
+ api_instance.users_user_id_delete(user_id)
+except ApiException as e:
+ print("Exception when calling UserApi->users_user_id_delete: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| user_id | +str | ++ | + |
void (empty response body)
+No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+++CloudEndureUser users_user_id_patch(body, user_id)
+
Modify user settings
+Configure which projects this user can receive e-mail notifications for.
+from __future__ import print_function
+import time
+from cloudendure import cloudendure_api
+from cloudendure.cloudendure_api.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = cloudendure_api.UserApi()
+body = cloudendure_api.CloudEndureUser() # CloudEndureUser |
+user_id = 'user_id_example' # str |
+
+try:
+ # Modify user settings
+ api_response = api_instance.users_user_id_patch(body, user_id)
+ pprint(api_response)
+except ApiException as e:
+ print("Exception when calling UserApi->users_user_id_patch: %s\n" % e)
+
+
+| Name | +Type | +Description | +Notes | +
|---|---|---|---|
| body | +CloudEndureUser | ++ | + |
| user_id | +str | ++ | + |
No authorization required
+[Back to top] [Back to API list] [Back to Model list] [Back to README]
+ + + + + + + + + + +Implemented enhancements:
+ +Fixed bugs:
+ +Implemented enhancements:
+Merged pull requests:
+Implemented enhancements:
+Fixed bugs:
+ +Fixed bugs:
+ +Closed issues:
+Implemented enhancements:
+ +Implemented enhancements:
+Merged pull requests:
+Implemented enhancements:
+ +Implemented enhancements:
+ +Closed issues:
+ +Merged pull requests:
+Implemented enhancements:
+ +Merged pull requests:
+Implemented enhancements:
+Fixed bugs:
+Closed issues:
+Merged pull requests:
+Merged pull requests:
+ +Merged pull requests:
+ +Closed issues:
+Implemented enhancements:
+Merged pull requests:
+ +Implemented enhancements:
+Fixed bugs:
+Closed issues:
+Merged pull requests:
+Implemented enhancements:
+Merged pull requests:
+Implemented enhancements:
+ +Implemented enhancements:
+ +Implemented enhancements:
+ +Merged pull requests:
+ +Implemented enhancements:
+ +* This Change Log was automatically generated by github_changelog_generator
+ + + + + + + + + + +Define the CloudEndure API wrapper related logic.
+Attributes: + API_VERSION (str): The CloudEndure API version to be used. + AUTH_TTL (str): The authentication token expiration in seconds. Defaults to: 3600. + HOST (str): The CloudEndure API URI. Defaults to: https://console.cloudendure.com + logger (logging.Logger): The default logger for the module.
+CloudEndureAPI(self, config: 'CloudEndureConfig', *args, **kwargs)
+
+
+Define the CloudEndure API base.
+Attributes: + api_endpoint (str): The CloudEndure API endpoint to be used for API calls. + credentials (dict): The mapping of CloudEndure credentials. + session (requests.Session): The requests Session to be used throughout the lifecycle + of this API interaction.
+CloudEndureAPI.login(username: 'str' = '',
+ password: 'str' = '',
+ token: 'str' = '')
+
+
+Login to the CloudEndure API console.
+Args: + username (str): The CloudEndure username to be used. + Defaults to the environment specific default. + password (str): The CloudEndure password to be used. + Defaults to the environment specific default. + token (str): The CloudEndure token to be used. This argument takes precedence. + If provided, username and password will not be used. + Defaults to the environment specific default.
+Attributes: + endpoint (str): The CloudEndure API endpoint to be used. + _username (str): The CloudEndure API username. + _password (str): The CloudEndure API password. + _token (str): The CloudEndure API token. + _auth (dict): The CloudEndure API username/password dictionary map. + response (requests.Response): The CloudEndure API login request response object. + _xsrf_token (str): The XSRF token to be used for subsequent API requests.
+TODO: + * Verify default XSRF-Token TTL and check validity before performing + subsequent authentication requests.
+CloudEndureAPI.get_endpoint(
+ path: 'str',
+ api_version: 'str' = 'latest',
+ host: 'str' = 'https://console.cloudendure.com')
+
+
+Build the endpoint path.
+Args: + path (str): The path to be requested. + api_version (str): The API version to be used. + For example: v5 + Defaults to: latest + host (str): The API URL to be used. + Defaults to: https://console.cloudendure.com
+Returns: + str: The CloudEndure API endpoint to be used.
+CloudEndureAPI.api_call(path: 'str',
+ method: 'str' = 'get',
+ data: 'Dict[str, Any]' = None)
+
+
+Handle CloudEndure API calls based on the defined parameters.
+Args: + path (str): The path to be used to perform the call.
+Keyword Args: + method (str): The API method call to be performed. i.e.: get, + data (dict): The data dictionary to be used to perform the request.
+Returns: + requests.models.Response: The CloudEndure API response.
+CloudEndureAPI.check_creds(login: 'bool' = True)
+
+
+Check the credential TTL. +
CloudEndureAPI.post_endpoint(path: 'str' = '')
+
+
+Create a POST request against the specified path. +
CloudEndureAPI.get_projects(current_project: 'str' = '')
+
+
+Get the CloudEndure projects associated with the authenticated account. +
CloudEndureAPI.docs()
+
+
+Open the CloudEndure API documentation page.
+ + + + + + + + + + +Define the CloudEndure main entry logic. +
CloudEndure(self,
+ project_name: 'str' = '',
+ dry_run: 'bool' = False,
+ username: 'str' = '',
+ password: 'str' = '',
+ token: 'str' = '')
+
+
+Define the CloudEndure general object. +
Display the CloudEndure module version.
+Returns: + str: The CloudEndure Python module version.
+CloudEndure.get_project_id(project_name: 'str' = '')
+
+
+Get the associated CloudEndure project ID by project_name.
+Args: + project_name (str): The name of the CloudEndure project.
+Exceptions: + Exception: Currently catch all encountered exceptions while traversing + the project list API call.
+Returns: + str: The CloudEndure project UUID.
+CloudEndure.get_cloud(cloud_type: 'str' = '')
+
+
+Get the ID for the specified cloud type. +
CloudEndure.create_cloud_credentials(access_key: 'str' = '',
+ secret_key: 'str' = '')
+
+
+Create a new CloudEndure project.
+Args: + project_name (str): The name of the CloudEndure project to be created.
+Returns: + str: The newly created CloudEndure project ID.
+CloudEndure.create_repl_config(region: 'str' = '',
+ cloud_cred_id: 'str' = '')
+
+
+Create a CloudEndure project replication configuration.
+Args: + project_name (str): The name of the CloudEndure project to get replication configurations for.
+Returns: + list of dict: The CloudEndure replication configuration dictionary mapping.
+CloudEndure.get_repl_configs()
+
+
+Get a CloudEndure project's replication configurations.
+Args: + project_name (str): The name of the CloudEndure project to get replication configurations for.
+Returns: + list of dict: The CloudEndure replication configuration dictionary mapping.
+CloudEndure.create_project(project_name: 'str')
+
+
+Create a new CloudEndure project.
+Args: + project_name (str): The name of the CloudEndure project to be created.
+Returns: + str: The newly created CloudEndure project ID.
+CloudEndure.update_project(project_data: 'Dict[str, Any]' = None)
+
+
+Update a CloudEndure project.
+Args: + project_name (str): The name of the CloudEndure project to be updated. + project_data (dict): The project payload to be used to update the project. + Defaults to the current project state.
+Returns: + bool: Whether or not the project has been updated.
+CloudEndure.check()
+
+
+Check the status of machines in the provided project. +
CloudEndure.update_encryption_key(kms_id: 'str')
+
+
+Update encryption keys for replication.
+Warning: This will cause re-sync if key does not match!
+Args: + kms_id (str): The AWS KMD ID to update the project to use. + project_name (str): The name of the CloudEndure project to be updated. + dry_run (bool): Whether or not this execution should be a dry run, + making no actual changes to CloudEndure for validation purposes.
+Returns: + bool: Whether or not the encryption key was updated.
+CloudEndure.check_licenses()
+
+
+Check licenses for all available instances in a given project. +
CloudEndure.get_machine_sync_details()
+
+
+Checks CloudEndure Project inventory and returns register machine replication state.
+CloudEndure.update_blueprint()
+
+
+Update the blueprint associated with the specified machines. +
CloudEndure.launch()
+
+
+Launch the test target instances. +
CloudEndure.status()
+
+
+Get the status of machines in the current wave. +
CloudEndure.execute()
+
+
+Start the migration project my checking and launching the migration wave. +
CloudEndure.replication(action: 'str', machine_ids: 'str' = '')
+
+
+Handle replication actions. +
CloudEndure.share_image(image_id: 'str',
+ image_name: 'str' = 'CloudEndureImage')
+
+
+Share the generated AMIs to the provided destination account. +
CloudEndure.create_ami()
+
+
+Create an AMI from the specified instances.
+Args: + project_name (str): The name of the CloudEndure project.
+Returns: + bool: Whether or not the AMI creation was successful.
+CloudEndure.copy_image(image_id: 'str')
+
+
+Copy a shared image to an account.
+Args: + image_id (str): The AWS AMI to be copied.
+Returns: + str: The copied AWS AMI ID.
+CloudEndure.split_image(image_id: 'str')
+
+
+Split the image into a root drive only AMI and a collection of snapshots.
+Args: + image_id (str): The AWS AMI to be copied.
+Returns: + dict: The mapping of AWS EBS block devices.
+CloudEndure.gen_terraform(image_id: 'str',
+ name: 'str' = 'INSTANCENAME',
+ subnet_id: 'str' = 'SUBNET_ID',
+ private_ip: 'str' = 'PRIVATE_IP',
+ keypair: 'str' = 'KEYPAIR',
+ security_group: 'str' = 'SECURITY_GROUP',
+ tagging_module: 'str' = 'tagging_module')
+
+
+Generate Terraform for a given split image.
+Args: + image_id (str): The split AMI ID to be referenced. + name (str): The name of the instance to be generated. + subnet_id (str): The AWS VPC Subnet ID to be referenced. + private_id (str): The internal IP address to associate with the AWS ENI. + keypair (str): The AWS EC2 keypair name to be referenced. + security_group (str): The AWS security group ID to be referenced.
+Returns: + str: The raw Terraform with volume, ENI, and EC2 instance templates.
+CloudEndure.terminate()
+
+
+Terminate the launched machine(s).
+Returns: + bool: Whether cleanup was successful.
+CloudEndure.delete_image(image_id: 'str')
+
+
+Remove the AMI and snapshots.
+Args: + image_id (str): The AWS AMI to be deleted.
+Returns: + bool: Whether the AMI deletion was requested successfully.
+main()
+
+
+Define the main entry method for the CLI.
+ + + + + + + + + + +Define the CloudEndure Config related logic. +
CloudEndureConfig(self,
+ username: 'str' = '',
+ password: 'str' = '',
+ token: 'str' = '',
+ *args,
+ **kwargs)
+
+
+Define the CloudEndure Config object. +
CloudEndureConfig.merge_config_dicts(values: 'List[Any]')
+
+
+Merge a list of configuration dictionaries. +
CloudEndureConfig.read_yaml_config()
+
+
+Read the CloudEndure YAML configuration file. +
CloudEndureConfig.write_yaml_config(config: 'Dict[str, Any]')
+
+
+Write to the CloudEndure YAML configuration file. +
CloudEndureConfig.update_yaml_config(kwargs: 'Dict[str, Any]')
+
+
+Update the YAML configuration file. +
CloudEndureConfig.get_env_vars(prefix: 'str' = 'cloudendure')
+
+
+Get all environment variables starting with CLOUDENDURE_. +
CloudEndureConfig.update_config()
+
+
+Update the configuration. +
CloudEndureConfig.update_token(token: 'str')
+
+
+Update the CloudEndure token.
+Returns: + bool: Whether or not the operation was successful.
+CloudEndureConfig.get_var(var: 'str')
+
+
+Get the specified environment or config variable.
+Returns: + str: The variable to be used for the provided configuration env var.
+ + + + + + + + + + +Define the CloudEndure reusable variables. +
get_aws_regions()
+
+
+Return a hardcoded dictionary of AWS regions.
+Returns: + dict: A mapping of AWS regions.
+ + + + + + + + + + +Define the CloudEndure events. +
EventHandler(self, events: 'List[Any]' = None)
+
+
+Define the handling of CloudEndure Event objects. +
EventHandler.add_event(event_type: 'Tuple[str, str]', machine_name,
+ **kwargs)
+
+
+Add an event. +
Event(self, event_type, machine_name: 'str' = 'NA', **kwargs)
+
+
+Define the structure of a CloudEndure Event.
+Usage: + from cloudendure.event import Event + some_event = Event(Event.EVENT_EXPIRED, somevar="some")
+Define the CloudEndure exceptions. +
CloudEndureException()
+
+
+Define the structure of a CloudEndure exception. +
CloudEndureHTTPException()
+
+
+Define the CloudEndure exception for unauthorized content. +
CloudEndureUnauthorized()
+
+
+The CloudEndure HTTP exception (401) was encountered for the request due to an unauthenticated request. +
CloudEndureForbidden()
+
+
+The CloudEndure HTTP exception (403) was encountered because the current user is not allowed access. +
CloudEndureNotFound()
+
+
+The CloudEndure HTTP exception (404) was encountered for the request due to the object not being found. +
CloudEndureMethodNotAllowed()
+
+
+The CloudEndure HTTP exception (405) raised when using a method that is not supported.
+For example: (POST instead of GET).
+CloudEndureUnprocessableEntity()
+
+
+The CloudEndure HTTP exception (422) was encountered due to invalid input. +
CloudEndureInvalidEvent()
+
+
+The CloudEndure exception for invalid Event types. +
CloudEndureMisconfigured()
+
+
+The CloudEndure exception indicating the CLI/Module hasn't been configured properly.
+ + + + + + + + + + +Define the CloudEndure API wrapper related logic. +
CloudEndureModel(self)
+
+
+Define the CloudEndure Model base object. +
CloudEndureModel.as_dict()
+
+
+Return a dict representation of the model. +
CloudEndureModel.parse(json: 'Dict[str, Any]')
+
+
+Parse a JSON object into a model instance. +
Cloud(self, **kwargs)
+
+
+Define the CloudEndure Cloud model schema. +
Cloud.parse(json: 'Dict[str, Any]')
+
+
+Parse the Cloud object. +
Project(self, **kwargs)
+
+
+Define the CloudEndure Project model schema. +
Project.parse(json: 'Dict[str, Any]')
+
+
+Parse the Project object. +
Machine(self, **kwargs)
+
+
+Define the CloudEndure Machine model schema. +
Machine.parse(json: 'Dict[str, Any]')
+
+
+Parse the Machine object.
+TODO: + * Add parsing for nested resources.
+ + + + + + + + + + +Define the CloudEndure template logic. +
CookiecutterHandler()
+
+
+Handle cookiecutter operations. +
CookiecutterHandler.run(
+ migration_data: 'Dict[str, Any]',
+ cookiecutter_path:
+ 'str' = 'https://github.com/2ndWatch/cookiecutter-tf-cloudendure')
+
+
+Run the automation of cookiecutter. +
CookiecutterHandler.create_project(package_path: 'str',
+ context: 'Dict[Any, Any]' = None,
+ no_input: 'bool' = True)
+
+
+Create a cookiecutter project with the provided details.
+Args: + package_path (str): The path to the cookiecutter template. + context (dict): The seed context to be used to populate cookiecutter values. + Defaults to an empty dictionary. + no_input (bool): Whether or not the interaction is no input. + Requires True in order to function for bulk creation. + Defaults to: True.
+Returns: + bool: Whether or not project creation was successful.
+TerraformTemplate()
+
+
+Define Terraform template entries.
+Attributes: + INSTANCE_TEMPLATE (str): The Terraform EC2 instance template. + NETWORKTEMPLATE (str): The Terraform network interface template. + VOLUME_TEMPLATE (str): The Terraform volume and volume attachment template.
+Define the CloudEndure utility logic.
+Attributes: + first_cap_re (re.Pattern): The regex pattern to determine the first capital + letter in a string. + all_cap_re (re.Pattern): The regex pattern to determine all capital letters + in a string.
+get_user_agent(user_agent: 'str' = 'cloudendure-python')
+
+
+Get the current module version.
+Args: + user_agent (str): The user agent client designation. + Defaults to: cloudendure-python
+Returns: + str: The user agent string representation for the client.
+get_time_now()
+
+
+Get the current time in UTC as milliseconds.
+Returns: + dict: The mapping of time now values in UTC.
+to_snake_case(value: 'str')
+
+
+Convert the provided value from CamelCase to snake_case.
+Args: + value (str): The string value to convert from CamelCase to snake_case.
+Returns: + str: The formatted snake_case string.
+ + + + + + + + + + +Define the CloudEndure lambda function.
+Attributes: + LOG_LEVEL (str): + REGION_OVERRIDE (str): If provided, this value will override the default AWS region. + logger (logging.Logger):
+get_ec2(credentials: 'Dict[str, str]', region: 'str' = '')
+
+
+Get an active EC2 boto3 client.
+ + + + + + + + + + +Define the Lambda specific exceptions. +
LambdaException()
+
+
+Define the generic AWS Lambda exception. +
InvalidPayload()
+
+
+Define the exception to be raised when an invalid payload is encountered. +
ImproperlyConfigured()
+
+
+Define the exception to be raised if the environment is improperly configured or missing.
+ + + + + + + + + + +Define the CloudEndure lambda function.
+Attributes: + LOG_LEVEL (str): + REGION_OVERRIDE (str): If provided, this value will override the default AWS region. + logger (logging.Logger): The logger to be used throughout execution of the AWS Lambda.
+send_sqs_message(image_info: 'Dict[str, Any]')
+
+
+Send a SQS message.
+The message includes the AMI information that was created from the migrated +instance that passed testing post migration in CloudEndure.
+Raises: + ClientError: The exception is raised in the event of a boto3 client error. + ImproperlyConfigured: The exception is raised in the event of missing or invalid + environment configuration settings.
+Returns: + bool: Whether or not the message has been sent successfully.
+create_ami(project_id: 'str', instance_id: 'str')
+
+
+Create an AMI from the specified instance.
+Args: + project_id (str): The ID associated with the Project. + instance_id (str): The ID associated with the AWS instance.
+Raises: + ClientError: The exception is raised in the event of a boto3 client error.
+Returns: + bool: Whether or not the AMI has been created successfully.
+lambda_handler(event: 'Dict[str, Any]', context: 'Dict[str, Any]')
+
+
+Define the AWS Lambda entry point and handler.
+Args: + event (str): The event performed against Lambda. + context (dict): The context of the request performed against Lambda.
+Raises: + ClientError: The exception is raised in the event of a boto3 client error. + InvalidPayload: The exception is raised in the event of an invalid payload.
+Returns: + bool: Whether or not the lambda function has executed successfully.
+ + + + + + + + + + +Python wrapper and CLI for CloudEndure
+ +pip install cloudendure
+cloudendure version
+
+
+brew install poetry # if not installed
+poetry install
+
+
+docker run --rm -it cloudendurepy/cloudendure bash
+
+
+Then import the package:
+import cloudendure
+
+
+CloudEndure Pipeline Flow
+
CloudEndure Data Flow
+
Pipeline Flow (as seen in AWS Console)
+
Please note: cloudendure and ce can be used interchangeably
export CLOUDENDURE_USERNAME=<your_ce_user>
+export CLOUDENDURE_PASSWORD=<your_ce_password>
+export CLOUDENDURE_DESTINATION_ACCOUNT=<destination_aws_account_id>
+
+cloudendure api login
+
+
+or
+export CLOUDENDURE_USER_API_TOKEN=<your_ce_user_api_token>
+export CLOUDENDURE_DESTINATION_ACCOUNT=<destination_aws_account_id>
+
+ce api login
+
+
+Please note: cloudendure and ce can be used interchangeably
cloudendure api login --user=<your_ce_user> --password=<your_ce_password>
+
+
+or
+ce api login --token=<your_ce_user_api_token>
+
+
+Logging in for the first time will generate the ~/.cloudendure.yml file.
This project is currently a work in progress and will actively change. This client has not yet been finalized and is entirely subject to change.
+Check out the CHANGELOG
+ + + + + + + + + + +Some errors are not specifically written in every method since they may always return. Those are:
+This project is currently in alpha and is not guaranteed. Please be warned... Your mileage may vary! +All current versions of this client are pre-releases.
+| Version | +Supported | +
|---|---|
| 0.0.x | +:x: | +
Please report bugs by raising a new issue on this repository: https://github.com/mbeacom/cloudendure-python/issues/new
+ + + + + + + + + + +