Create/Edit Input Property for Service dialog box

The following table describes the Create/Edit Input Property for Service dialog box fields, subfields, and field groups. A field group is a collection of fields that are related to a specific action or configuration.

When you enter information in a dialog box, if the information is not valid, errors that include a description of the problem appear at the right side of the box.

Creating a validator script for verifying an input property

If the validation options are not adequate, you can create a script. Following is an example of a validator script written in Javascript code that verifies whether a value entered by the user is a number less than the maximum allowable value of 1024:

function(propertyValue, lang, displayType){
  var jObject = JSON.parse(propertyValue.value);
  if(displayType == "config"){
    if( jObject.luSize > 10){
      return "lu size should be under 10"
    }
    if( jObject.blockSize > 2){
      return "block size should be under 2";
    }
  }
  
 return
}

The following table shows the validator script specifications for the input property.

Using external resource data for input properties

When you specify "Selection" as the input property presentation, you can use the external resource data listed in the menu. You can create the external resource provider by using Service Builder to set up and access the external resource data.

Create an external resource provider by using Service Builder

You can create a new external resource provider by clicking Add New External Resource Provider at the bottom of the list. You can also specify an existing external resource provider from the list.

In the Create External Resource Provider dialog box, enter the following information:

• Name: Specifies the name of the external resource provider.
• Version: Specifies the version number.
• Content Type: Selects either application/json or text/csv.
• Schema ID: Specifies the schema ID of the domain type corresponding to the external resource provider. This helps users select an external resource provider in the property for service and plug-in setting dialog boxes; in the list of external resource providers, those with the same schema ID as the selected domain type are highlighted in blue.
• Description: Specifies a description for the external resource provider.
• Type: Select either Javascript, Script, Command Line, or File. Depending on your selection, enter the required information in the field.

When specifying Javascript for the type

The following table shows the Javascript specifications for the external resource provider.

In the script, you can use one of the following utility functions:

• Built-in CM-REST methods
• env function
• auto util library

Using the built-in CM-REST methods

You can use the modules that are available in the JavaScript Plug-in for Configuration Manager REST API as follows:

• ConfigurationManager._0x_xx_xx.api
• ConfigurationManager._0x_xx_xx.model
• ConfigurationManager._0x_xx_xx.enum
• ConfigurationManager._0x_xx_xx.lib

Using env functions

You can use "env" functions to get context information. The following table shows the specification of the functions of the env object.

Using the auto util library

You can also use the auto util library. See the auto util library in the JavaScript Plug-in topic for more information.

The following shows sample codes when migrating from the code using the built-in CM-REST methods and the env function to the code using the auto util library as a means of running the Configuration Manager REST API.

Following is an sample code using the built-in CM-REST methods and the env function.

function fn(requestPath, queryParamMap, properties) {
  /** This is sample code that calls the Configuration Manager REST API. */
  /** Replace <VERSION> with the available version of the JavaScript Plug-in for Configuration Manager REST API. (e.g., put "_01_62_00" for the version of 01.62.00) */

  //Step 1. Instantiate the API Client.
  var client = new ConfigurationManager._02_80_00.api.ObjectsApi();

  //Step 2. Specify the User Credentials. There are two methods for specifying user credentials. You can use either method, but the first one is recommended.
  //Specify credentials by using the Web Service Connection.
  //Get accessible Web Service Connections by specifying a category name, and specify it. You do not need to specify credentials in a script.
  var wsc = env.getWebServiceConnections("ConfigurationManager");
  env.setWebServiceConnection(client, wsc[0].productName, wsc[0].name, "/ConfigurationManager");

  //Step 3. Get Session
  //You can pass arguments by using the plug-in input properties or you can specify them directly in a script. For example, you can pass the device ID through the query parameters (queryParamMap).
  var argSessionsPost = new ConfigurationManager._02_80_00.argDef.ObjectsApi.v1.objects.storages.storageDeviceID.sessions.post();
  argSessionsPost.setStorageDeviceID(queryParamMap.deviceId);
  var responseBody = client.v1.objects.storages.storageDevice
  ID.sessions.post(argSessionsPost);
  var token = responseBody.getToken();
  var sId = responseBody.getSessionId();

  //Step 4. Call the API that is associated with your use case based on the session obtained in Step 3.
  var argPoolsGet = new ConfigurationManager._02_80_00.argDef.ObjectsApi.v1.objects.storages.storageDeviceID.pools.get();
  argPoolsGet.setStorageDeviceID(queryParamMap.deviceId);
  argPoolsGet.setPoolType("DP");
  client.getApiClient().setApiKeyPrefix("Session");
  client.getApiClient().setApiKey(token);
  var pools = client.v1.objects.storages.storageDeviceID.pools.get(argPoolsGet);

  //Step 5. Make an array containing the required information.
  //An array to be returned has to be set to a property named "data".
  var ret = { "data": [] };
  var p;
  for (var i = 0; i < pools.getData().length; i++) {
    p = pools.getData()[i];
    ret.data.push({
      "Pool ID": p.getPoolId(),
      "Pool Type": p.getPoolType(),
      "Num of LDEVs": p.getNumOfLdevs()
    });
  }

  //Final Step. Discard Session.
  var argSessionIdDelete = new ConfigurationManager._02_80_00.argDef.ObjectsApi.v1.objects.storages.storageDeviceID.sessions.sessionId.delete();
  argSessionIdDelete.setStorageDeviceID(queryParamMap.deviceId);
  argSessionIdDelete.setSessionId(String(sId));
  client.v1.objects.storages.storageDeviceID.sessions.sessionId.delete(argSessionIdDelete);

  return ret;
  
}

Following is a sample code using the auto util library

function fn(requestPath, queryParamMap, properties) {
  /** This is sample code that calls the Configuration Manager REST API. */

  //Step 1. Generate a method to run REST API to Configuration Manager.
  var configurationManagerCall = function(request) {
    var respBody = null;
    auto.util.http.handleCall(auto.util.storage.restCall, request,
      function(resp, req) {
        respBody = auto.util.parseJson(resp.responseBody);
      }, function(resp, req) {
        auto.util.http.defaultErrorHandler(null, req, resp);
      }, function(err, req) {
        auto.util.http.defaultErrorHandler(err, req);
      }, auto.util.storage.retrySettings
    );
    return respBody;
  };
  
  //Step 2. Get accessible Web Service Connections by specifying a category name.
  var wsc = auto.util.env.getWebServiceConnections("ConfigurationManager");
  
  //Step 3. Get Session
  //You can pass arguments by using the plug-in input properties or you can specify them directly in a script. For example, you can pass the device ID through the query parameters (queryParamMap).
  var request = {
    "requestMethod": "POST",
    "requestUrl": "/ConfigurationManager/v1/objects/storages/" + queryParamMap.deviceId + "/sessions",
    "requestHeaders": auto.util.http.toRawHeader({}),
    "authScheme": "basic",
    "connectionName": wsc[0].name,
    "productName": wsc[0].productName
  };
  var respBody = configurationManagerCall(request);
  var token = respBody.token;
  var sId = respBody.sessionId;

  //Step 4. Call the API that is associated with your use case based on the session obtained in Step 3.
//When specifying the Authorization header for the request in the user program, specify "none" for authScheme.
  var headers = {
    "Authorization": "Session " + token,
  };
  var queryMap = {
    "poolType" : "DP"
  };
  var queryStr = auto.util.http.buildQuery(queryMap);
  request = {
    "requestMethod": "GET",
    "requestUrl": "/ConfigurationManager/v1/objects/storages/" + queryParamMap.deviceId + "/pools" + queryStr,
    "requestHeaders": auto.util.http.toRawHeader(headers),
    "authScheme": "none",
    "connectionName": wsc[0].name,
    "productName": wsc[0].productName
  };
  var pools = configurationManagerCall(request);

  //Step 5. Make an array containing the required information.
  //An array to be returned has to be set to a property named "data".
  var ret = { "data": [] };
  var p;
  for (var i = 0; i < pools.data.length; i++) {
    p = pools.data[i];
    ret.data.push({
      "Pool ID": p.poolId,
      "Pool Type": p.poolType,
      "Num of LDEVs": p.numOfLdevs
    });
  }

  //Final Step. Discard Session.
  request = {
    "requestMethod": "DELETE",
    "requestUrl": "/ConfigurationManager/v1/objects/storages/" + queryParamMap.deviceId + "/sessions/" + sId,
    "requestHeaders": auto.util.http.toRawHeader(headers),
    "authScheme": "none", 
    "connectionName": wsc[0].name,
    "productName": wsc[0].productName
  };
  configurationManagerCall(request);

  return ret;

}

When specifying Script for the type

Python is supported as a script type. Specify the path to the Python interpreter that runs the script, and edit a script. The supported versions of Python are version 3.x series. To use this external resource provider in a cluster environment, the Python interpreter must be installed on both the active and standby systems. This external resource provider does not support a virtual Python environment.

Environment variables that can be referenced from the script

The following table shows the environment variables that are allowable in the script. You can get the values for the following environment variables in the os.environ[key-name] or os.environ.get(key-name) format.

When specifying command line for the type

Enter the command line to run.

• An error is generated if the return value of the command is not 0.
• The upper limit for standard output is 30 MB and an error is generated if this limit is exceeded.
• When specifying a script file, use the absolute path because the current path is not specified.
• The service share property and the reserved property can be included in a command line. If including a service share property or a reserved property, surround the property key with "${" and "}".
• The character set for a standard output assumes the character set of the system and the associated user. (For example, in the case of Windows OS with Japanese Locale, MS-932, and in the case of Linux OS, the user who last ran the start command.)
• In the command line, you can refer to the values for the environment variables. The referable environment variables are the same as when specifying Script for the type. Note that the method of obtaining the value for the environment variable depends on the script language, as shown in the following table.

The following example shows how host names are acquired through a program such as Powershell, and are then visible in a list as follows:

Command line:
powershell.exe \"& '${reserved.external.resource.dir}\\getHosts.ps1' ${reserved.external.hcmds.dir} ${reserved.external.userName}\"

Output of a command line:
name,instanceID
host1,123
host2,124
host3,125
host4,126
host5,127

The list item displayed on the Config/Submit window of the service:
host1
host2
host3
host4
host5

When specifying file for the type

Enter the path of the files. The service share property and the reserved property can be included in a file path. If including a service share property or a reserved property, surround the property key with "${" and "}".

In the following example, the host data is acquired from JSON file and output by using another application.

File：
${reserved.external.resource.dir}\\vm.json

vm.json ：
{
"data" :[ {
"instanceID" :127,
"name" :"test1"
}, {
"instanceID" :128,
"name" :"test2"
} ]
}

The list item displayed on the Config/Submit window of the service:
test1
test2

Upload a file to an external resource provider

You can upload files to an external resource provider by clicking Upload in the external resource provider list. You can update a .zip archive file. After updating files, you can specify the relative path name in the command line as a file path.

Delete an external resource provider

You can delete an external resource provider by clicking Delete in the external resource provider list. When you click Delete, the Delete Confirmation dialog box appears. The dialog box lists the service templates and plug-ins using the external resource provider you plan to delete. When you confirm that there is no related service templates and plug-ins, click OK and the external resource is deleted. If you delete an external resource provider that is used by a service template, the external resource provider no longer works with the service template.