14.40 ListNetworkResource (Obtain a List of Network Resources)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\ListNetworkResource - Obtain a List of Network Resources

[Linux Manager]
/opt/FJSVcfmg/bin/ListNetworkResource.sh - Obtain a List of Network Resources

Synopsis

[Windows Manager]

ListNetworkResource -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name [-networkCategory network type] [-segmentType segment identifier information] [-showTenant tenant name display]

[Linux Manager]

ListNetworkResource.sh -version version ID -locale the language for communicating -userId user ID -password password -orgId tenant name [-networkCategory network type] [-segmentType segment identifier information] [-showTenant tenant name display]

Function description

This commnad obtains a list of network resources.

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.

-networkCategory(optional): Specify the network type.

-segmentType(optional): Specify segment identifier information.

-showTenant(optional): Specify the tenant name display option.

Requirements

Permissions: User with OS administrator privilege

Location: Admin server

Example

[Windows Manager]

> ListNetworkResource -version 2.0 -locale en -userId user3 -password password -orgId tenantA -networkCategory MANAGEMENT -segmentType DMZ -showTenant true
<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set10</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>138</avail>
        <num>140</num>
        <used>2</used>
      </addressSetStatus>
      <locked>true</locked>
      <networkCategory>BUSINESS</networkCategory>
      <vlanId>11</vlanId>
      <resourceId>network-t-0001</resourceId>
      <resourceName>tenantA-DMZ</resourceName>
      <segmentType>DMZ</segmentType>
      <tenantName>tenantA</tenantName>
    </network>
  </networks>
</ListNetworkResourceResponse>

[Linux Manager]

# ListNetworkResource.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -networkCategory MANAGEMENT -segmentType DMZ -showTenant true
<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>192.xxx.xxx.xxx</end>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set10</name>
        <start>192.xxx.xxx.xxx</start>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>138</avail>
        <num>140</num>
        <used>2</used>
      </addressSetStatus>
      <locked>true</locked>
      <networkCategory>BUSINESS</networkCategory>
      <vlanId>11</vlanId>
      <resourceId>network-t-0001</resourceId>
      <resourceName>tenantA-DMZ</resourceName>
      <segmentType>DMZ</segmentType>
      <tenantName>tenantA</tenantName>
    </network>
  </networks>
</ListNetworkResourceResponse>

Exit Status

This command returns the following values:

0: The command executed successfully.

non-zero: An error has occurred.