IBM Cloud DrAutomation Node SDK

Node.js client library to interact with various IBM Cloud DrAutomation services.

Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.

Table of Contents

• Overview
• Prerequisites
• Installation
• Using the SDK
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud DrAutomation services Node.js SDK allows developers to programmatically interact with the following IBM Cloud services:

Service Name - Plan	Import Path
DrAutomation Service	dra-node-sdk/dr-automation-service/v1
PowerHA Service	dra-node-sdk/powerha-automation-service/v1

Prerequisites

• You need an IBM Cloud account.
• Node.js >=18: This SDK is tested with Node.js versions 18 and up. It may work on previous versions but this is not officially supported.

Installation

npm install @ibm-cloud/ibm-dr-automation-service

How to Import

Example – DrAutomation Service-Plan

const DrAutomationServiceV1 = require('@ibm-cloud/ibm-dr-automation-service');

where DrAutomationServiceV1 is the service's module name from the table above

Example – PowerHA Service-Plan

const PowerhaAutomationServiceV1 = require('@ibm-cloud/ibm-dr-automation-service/powerha-automation-service/v1');

where PowerhaAutomationServiceV1 is the service's module name from the table above

Using the SDK

For general SDK usage information, please see this link

Environment Configuration

The SDK can be configured using environment variables. Here's an example configuration:

DrAutomation Service Configuration

# Authentication type
export DR_AUTOMATION_SERVICE_AUTH_TYPE=bearerToken

# Bearer token for authentication
export DR_AUTOMATION_SERVICE_BEARER_TOKEN=GenratedToken

PowerHA Service Configuration

# Authentication type
export POWERHA_AUTOMATION_SERVICE_AUTH_TYPE=bearerToken

# Bearer token for authentication
export POWERHA_AUTOMATION_SERVICE_BEARER_TOKEN=GenratedToken

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

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.

Issues

If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.

License

This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.