14.2.1 CreateLPlatform (Creates an L-Platform)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\CreateLPlatform - Creates an L-Platform

[Linux Manager]
/opt/FJSVcfmg/bin/CreateLPlatform.sh - Creates an L-Platform

Synopsis

[Windows Manager]

CreateLPlatform -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformDescriptorId L-Platform_template_ID -lplatformName L-Platform_name [-vdiUser VDI_user_name]

[Linux Manager]

CreateLPlatform.sh -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformDescriptorId L-Platform_template_ID -lplatformName L-Platform_name [-vdiUser VDI_user_name]

Function description

This command creates an L-Platform based on a template.
If the template contains servers with the same name, then each one will be suffixed with a unique number (starting from 1).

This command is executed asynchronously. During deployment the status of the L-Platform shifts to DEPLOYING, while configuring software it shifts to SETUP, and when deployment is complete, the status of the L-Platform becomes NORMAL.
Operation of an L-Platform is not possible until the status of the L-Platform has shifted to NORMAL.
Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.

Note

When a physical server is included in a template, only two commands can be executed simultaneously, due to the limitations of the hardware that is set.
When creating more than two L-Platforms with physical servers, leave some time between the executions of this command.
When an L-Platform template that includes a segment specifying [Auto-Select] is specified, configure the settings for the number of CreateLPlatform commands that can be simultaneously executed so that the number of IP addresses required on all L-Platforms that will be deployed concurrently is no greater than the highest number of available IP addresses in those segments that will be selected automatically.
For example, if two segments will be selected automatically, and these segments have 5 and 4 available IP addresses respectively, up to five CreateLPlatform commands can be executed simultaneously if one IP address per L-Platform is required.

Options

-version: Specify the version ID of the L-Platform API.

-locale: Specify the language used to communicate with the L-Platform API.

-userId: Specify the user ID for executing the L-Platform API.

-password: Specify the password for the user ID for executing the L-Platform API.

-orgId: Specify the tenant name of the user for executing the L-Platform API.

-lplatformDescriptorId: Specify the L-Platform template ID.

-lplatformName: Specify the L-Platform name.

-vdiUser (optional): Specify the VDI user name.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> CreateLPlatform -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformDescriptorId template-13820fb2858 -lplatformName lplatform1
<?xml version="1.0" encoding="UTF-8"?>
<CreateLPlatformResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformId>tenantA-M3PGGWCFX</lplatformId>
</CreateLPlatformResponse>

[Linux Manager]

# CreateLPlatform.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformDescriptorId template-13820fb2858 -lplatformName lplatform1
<?xml version="1.0" encoding="UTF-8"?>
<CreateLPlatformResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformId>tenantA-M3PGGWCFX</lplatformId>
</CreateLPlatformResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.