JavaScript Plug-in for Configuration Manager REST API

The JavaScript Plug-in for Configuration Manager REST API runs any script written in JavaScript and includes methods for accessing Configuration Manager REST API.

The relationship between the specification of Configuration Manager REST API and the specification of methods and data models that are available in the script of this plug-in, is as follows:

• The path name of each API, the method with the name where the "/"(slash) separator is replaced with a "."(dot) separator, is provided through the plug-in.
• The HTTP Method can be specified such as "~.get(…", "~.post(…" at the end of the method name.
• The variables and the query parameters in the API path can be specified as the arguments of the method.
• The Request Body can be given to the arguments as the relevant data model.

When the HTTP status code of the Configuration Manager REST API is 503, the retry is performed with the following retry count and interval:

• Retry count: 130
• Retry interval: 30 seconds

The maximum number of concurrent plug-in runs is 30. Even if you specify a value more than 30 for plugin.threadPoolSize in config_user.properties, the number of concurrent plug-in runs is limited to 30.

If the specified value for plugin.threadPoolSize is less than or equal to 30, the maximum number of concurrent plug-in runs will be the specified value for plugin.threadPoolSize.

Return codes

The JavaScript Plug-in for Configuration Manager REST API generates the following return codes.

Property list

The following properties are available for the JavaScript Plug-in for Configuration Manager REST API:

The setting value of Web Service Connection can be referred to as a value of the input property of the Plug-in. In this case, the corresponding input property is overwritten by the setting value of the Web Service Connection. Whether to refer to the setting value of Web Service Connection is determined by the input value of webServiceConnectionCategory and webServiceConnectionName. When referring to the setting value of WebServiceConnection, the URL (property name: baseUrl) is ignored.

You specify the plug-in input/output properties in the property list. Combinations of service property values, reserved property values, and literal characters can be used for the input properties.

JavaScript code specifiable for the JavaScript body

The following table shows the JavaScript codes that are allowable in the body of the script:

Sample code (scriptBody)

The following examples show the sample code of Configuration Manager REST API (HTTP) and the JavaScript that can be specified in the plug-in property JavaScript body:

Obtain Pool Information

[In the case of Configuration Manager REST API (HTTP)]
HTTP Method: GET
Request URL: ../ConfigurationManager/v1/objects/storages/<storageDeviceID>/pools?poolType=<poolType>
Request Body: None

[In the case of JavaScript Plug-in for Configuration Manager REST API]
var client = new api.ObjectsApi();
var arg = new argDef.ObjectsApi.v1.objects.storages.storageDeviceID.pools.get();
arg.setStorageDeviceID(<storageDeviceID>);
arg.setDetailInfoType(<detailInfoType>);
arg.setPoolType(<poolType>);
arg.setResponseMaxWait(<responseMaxWait>);
arg.setResponseJobStatus(<responseJobStatus>);

client.v1.objects.storages.storageDeviceID.pools.get(arg);

Register the Pool information

[In the case of Configuration Manager REST API (HTTP)]
HTTP Method: POST
Request URL: ../ConfigurationManager/v1/objects/storages/<storageDeviceID>/pools
Request Body: { "poolId": 76, "poolName": "pool1", "ldevIds": [405], "poolType": "HDP" }

[In the case of JavaScript Plug-in for Configuration Manager REST API]
var reqBody = {
  poolId:76,
  poolName:"pool1",
  ldevIds:[405],
  poolType:"HDP"
};

var client = new api.ObjectsApi();
var arg = new argDef.ObjectsApi.v1.objects.storages.storageDeviceID.pools.post();
arg.setStorageDeviceID(<storageDeviceID>);
arg.setRequestBody(reqBody);
arg.setResponseMaxWait(<responseMaxWait>);
arg.setResponseJobStatus(<responseJobStatus>);

client.v1.objects.storages.storageDeviceID.pools.post(arg);

Sample code (scriptBody/importedScript)

The following examples show the sample code of Configuration Manager REST API that can be specified in the plug-in property scriptBody/importedScript:

-------------------------------------------
(scriptBody)
-------------------------------------------
function fn(serviceProperties, pluginProperties, arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9) {

  hoge(CNST);

}
-------------------------------------------
(importedScript)
-------------------------------------------
var CNST = "hoge";

function hoge(a){
  print(a + " from common js!");
}
-------------------------------------------