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

14.2.10 ListNetworkInfo (Gets Network Information for an L-Platform)

Name

[Windows Manager]
Installation_folder\RCXCFMG\bin\ListNetworkInfo - Gets Network Information for an L-Platform

[Linux Manager]
/opt/FJSVcfmg/bin/ListNetworkInfo.sh - Gets Network Information for an L-Platform

Synopsis

[Windows Manager]

ListNetworkInfo -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformId L-Platform_ID

[Linux Manager]

ListNetworkInfo.sh -version version_ID -locale the_language_for_communicating -userId user_ID -password password -orgId tenant_name -lplatformId L-Platform_ID

Function description

This command gets network information for the target L-Platform.

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.

-lplatformId

Specify the L-Platform ID.

Requirements

Permissions

User with OS administrator privilege

Location

Admin server

Example

[Windows Manager]

> ListNetworkInfo -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX
<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkInfoResponse 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>
      <name>N01</name>
      <networkCategory>BUSINESS</networkCategory>
      <networkId>M3PGGWCFX-N-INTRANET</networkId>
      <numOfMaxVm>10</numOfMaxVm>
      <resourceId>mngsrv_1234</resourceId>
      <segmentType>DMZ</segmentType>
    </network>
    <network>
      <addressSet>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set20</name>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>116</avail>
        <num>120</num>
        <used>4</used>
      </addressSetStatus>
      <excludeaddressranges>
        <excludeaddressrange>
          <end>192.xxx.xxx.xxx</end>
          <start>192.xxx.xxx.xxx</start>
        </excludeaddressrange>
      </excludeaddressranges>
      <name>N02</name>
      <networkCategory>MANAGEMENT</networkCategory>
      <networkId>M3PGGWCFX-N-INTERNET</networkId>
      <numOfMaxVm>10</numOfMaxVm>
      <resourceId>mngsrv_1235</resourceId>
      <segmentType>SECURE</segmentType>
    </network>
  </networks>
</ListNetworkInfoResponse>

[Linux Manager]

# ListNetworkInfo.sh -version 2.0 -locale en -userId user3 -password password -orgId tenantA -lplatformId tenantA-M3PGGWCFX
<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkInfoResponse 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>
      <excludeaddressranges/>
      <name>N01</name>
      <networkCategory>BUSINESS</networkCategory>
      <networkId>M3PGGWCFX-N-INTRANET</networkId>
      <numOfMaxVm>10</numOfMaxVm>
      <resourceId>mngsrv_1234</resourceId>
      <segmentType>DMZ</segmentType>
    </network>
    <network>
      <addressSet>
        <mask>255.xxx.xxx.xxx</mask>
        <name>addr_set20</name>
        <subnet>192.xxx.xxx.xxx</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>116</avail>
        <num>120</num>
        <used>4</used>
      </addressSetStatus>
      <excludeaddressranges>
        <excludeaddressrange>
          <end>192.xxx.xxx.xxx</end>
          <start>192.xxx.xxx.xxx</start>
        </excludeaddressrange>
      </excludeaddressranges>
      <name>N02</name>
      <networkCategory>MANAGEMENT</networkCategory>
      <networkId>M3PGGWCFX-N-INTERNET</networkId>
      <numOfMaxVm>10</numOfMaxVm>
      <resourceId>mngsrv_1235</resourceId>
      <segmentType>SECURE</segmentType>
    </network>
  </networks>
</ListNetworkInfoResponse>

Exit Status

This command returns the following values:

0

The command executed successfully.

non-zero

An error has occurred.