6.12 Advanced Workload Protection Topics

6.12.1 Using Workload Protection Features through the PlateSpin Forge Web Services API

PlateSpin Forge exposes a REST-based API technology preview that developers can use as they build their own applications to work with the product. The API includes information about the following operations:

  • discover containers

  • discover workloads

  • configure protection

  • run replications, failover operations and failback

  • query for status of workload and container status

  • query for status of running operations

  • query security groups and their protection ties

Forge administrators can leverage a Jscript sample (https://localhost/protectionservices/Documentation/Samples/protect.js) from the command line to access the product through the API. The sample can help you write scripts to help you work with the product. Using the command line utility, you can perform the following operations:

  • add a single workload

  • add a single container

  • run the replication, failover, and failback operations

  • add multiple workloads and containers at one time

    NOTE:For more information about this operation, see the API documentation at https://localhost/protectionservices/Documentation/AddWorkloadsAndContainersFromCsvFile.htm.

  • remove all workloads at one time

  • remove all container at one time

The PlateSpin Forge REST API home page (https://localhost/protectionservices/ or https://<server page>/protectionservices/) includes links to the content that can be useful for developers and administrators.

This technology preview will be fully developed with more features in subsequent releases.