ServerView Resource Orchestrator Cloud Edition V3.1.1 Reference Guide (Command/XML)

14.37 ListLPlatformDescriptor (Gets a List of Templates)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\ListLPlatformDescriptor - Gets a List of Templates

[Linux Manager]
/opt/FJSVcfmg/bin/ListLPlatformDescriptor.sh - Gets a List of Templates

Synopsis

[Windows Manager]

ListLPlatformDescriptor -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name [-keyword kewword]

[Linux Manager]

ListLPlatformDescriptor.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name [-keyword kewword]

Function description

This command gets a list of the templates in the virtual data center.

At the same time, the command also gets attribute information for templates.

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.

-keyword(optional)

Specify a keyword to use to filter templates in the list.

Requirements

Permissions

User with OS administrator privilege

Location

Admin server

Example

[Windows Manager]

> ListLPlatformDescriptor -version 2.0 -locale en -userId user3 -password password -orgId tenantA -keyword sample
<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>user3</creatorName>
      <description>sample1</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>template-138141e01cc</lplatformdescriptorId>
      <lplatformdescriptorName>sampleTemplate1</lplatformdescriptorName>
    </lplatformdescriptor>
    <lplatformdescriptor>
      <creatorName>cfmgadm</creatorName>
      <description>sample2</description>
      <registrant>user3</registrant>
      <lplatformdescriptorId>template-138241e02dd</lplatformdescriptorId>
      <lplatformdescriptorName>sampleTemplate2</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>

[Linux Manager]

# ListLPlatformDescriptor.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -keyword sample
<?xml version="1.0" encoding="UTF-8"?>
<ListLPlatformDescriptorResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <lplatformdescriptors>
    <lplatformdescriptor>
      <creatorName>user3</creatorName>
      <description>sample1</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>template-138141e01cc</lplatformdescriptorId>
      <lplatformdescriptorName>sampleTemplate1</lplatformdescriptorName>
    </lplatformdescriptor>
    <lplatformdescriptor>
      <creatorName>user3</creatorName>
      <description>sample2</description>
      <registrant>cfmgadm</registrant>
      <lplatformdescriptorId>template-138241e02dd</lplatformdescriptorId>
      <lplatformdescriptorName>sampleTemplate2</lplatformdescriptorName>
    </lplatformdescriptor>
  </lplatformdescriptors>
</ListLPlatformDescriptorResponse>

Exit Status

This command returns the following values:

0

The command executed successfully.

non-zero

An error has occurred.