Python client library to interact with various IBM Cloud DrAutomation services APIs.
Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.
- Overview
- Prerequisites
- Installation
- Using the SDK
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
The IBM Cloud DrAutomation services Python SDK allows developers to programmatically interact with the following IBM Cloud services:
| Service Name - Plan | Module Name | Imported Class Name |
|---|---|---|
| DrAutomation Service | ibm_dra_python_sdk.dr_automation_service_v1 | DrAutomationServiceV1 |
| PowerHA Service | ibm_dra_python_sdk.powerha_automation_service_v1 | PowerhaAutomationServiceV1 |
- An IBM Cloud account.
- An IAM API key to allow the SDK to access your account. Create one here.
- Python 3.10 or above.
To install, use pip:
python -m pip install --upgrade ibm-dra-python-sdkThen in your code, you can import the appropriate service like this:
from ibm_dra_python_sdk.dr_automation_service_v1 import *
where dr_automation_service_v1 is the service's module name from the table above
from ibm_dra_python_sdk.powerha_automation_service_v1 import *
where powerha_automation_service_v1 is the service's module name from the table above
For general SDK usage information, please see this link
The SDK can be configured using environment variables. Here's an example configuration:
# Authentication type
export DR_AUTOMATION_SERVICE_AUTH_TYPE=bearerToken
# Bearer token for authentication
export DR_AUTOMATION_SERVICE_BEARER_TOKEN=<bearerToken># Authentication type
export POWERHA_AUTOMATION_SERVICE_AUTH_TYPE=bearerToken
# Bearer token for authentication
export POWERHA_AUTOMATION_SERVICE_BEARER_TOKEN=<bearerToken>Note: The bearer token shown above is an example. For production use:
- Use the actual service endpoint URL
- Generate your own valid IAM bearer token
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.md.
This SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.