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

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

Request parameters

Parameter name	Item	Item description
Version	Description	The version ID of the L-Platform API.
	Type	string
	Value	Fixed. Specify "2.0".
Locale	Description	The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639.
	Type	string
	Value	Select one of the following: - en: English - zh: Chinese
Action	Description	The name of the L-Platform API to be executed.
	Type	string
	Value	Fixed. Specify "ListNetworkInfo".
userId	Description	The user ID of the user that executes the L-Platform API.
	Type	string
	Value	No more than 31 characters.
orgId	Description	The tenant name of the user that executes the L-Platform API.
	Type	string
	Value	No more than 32 characters.
lplatformId	Description	L-Platform ID.
	Type	string
	Value	No more than 32 characters.

Response

The API returns "200 OK" if it terminates normally.

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkInfoResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
  <networks>
    <network>
      <addressSet>
        <end>[End address of the address set]</end>
        <mask>[Netmask of the address set]</mask>
        <name>[Address set name]</name>
        <start>[Leading address of the address set]</start>
        <subnet>[Subnet address of the address set]</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>[Number of vacant addresses in the address set]</avail>
        <num>[Total number of addresses in the address set]</num>
        <used>[Number of reserved addresses in the address set]</used>
      </addressSetStatus>
      <excludeaddressranges>
        <excludeaddressrange>
          <end>[End address of the excluded addresses]</end>
          <start>[Leading address of the excluded addresses]</start>
        </excludeaddressrange>
      </excludeaddressranges>
      <name>[Network name]</name>
      <networkCategory>[Network type]</networkCategory>
      <networkId>[Network ID]</networkId>
      <numOfMaxVm>[Maximum number of VMs]</numOfMaxVm>
      <resourceId>[Network resource ID]</resourceId>
      <segmentType>[Segment type information]</segmentType>
    </network>
  </networks>
</ListNetworkInfoResponse>

Element name	Item	Item description
ListNetworkInfoResponse	Description	Element holding the response information
	Type	None
	Number of occurrences	1
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chaper 15 Messages Starting with PAPI" in the "Messages" for message details.
	Type	string
	Number of occurrences	1
responseStatus	Description	Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.
	Type	string
	Number of occurrences	1
networks	Description	Element holding the response information for the network information
	Type	None
	Number of occurrences	0 or 1
network	Description	Set of network information
	Type	None
	Number of occurrences	As many as there are networks elements (0 or more elements for each networks element).
addressSet	Description	Set of address set information
	Type	None
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
end	Description	The end address of the address set
	Type	string
	Number of occurrences	As many as there are addressSet elements (0 or 1 element for each addressSet element).
mask	Description	The netmask of the address set.
	Type	string
	Number of occurrences	As many as there are addressSet elements (0 or 1 element for each addressSet element).
name	Description	Address set name
	Type	string
	Number of occurrences	As many as there are addressSet elements (0 or 1 element for each addressSet element).
start	Description	The leading address of the address set
	Type	string
	Number of occurrences	As many as there are addressSet elements (0 or 1 element for each addressSet element).
subnet	Description	The subnet address of the address set
	Type	string
	Number of occurrences	As many as there are addressSet elements (0 or 1 element for each addressSet element).
addressSetStatus	Description	Set of address set status information
	Type	None
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
avail	Description	Number of vacant addresses in the address set.
	Type	int
	Number of occurrences	As many as there are addressSetStatus elements (0 or 1 element for each addressSetStatus element).
num	Description	Number of addresses in the address set.
	Type	int
	Number of occurrences	As many as there are addressSetStatus elements (0 or 1 element for each addressSetStatus element).
used	Description	Number of reserved addresses in the address set.
	Type	int
	Number of occurrences	As many as there are addressSetStatus elements (0 or 1 element for each addressSetStatus element).
excludeaddressranges	Description	Element holding the response information for the excluded address information.
	Type	None
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
excludeaddressrange	Description	Set of excluded address information.
	Type	None
	Number of occurrences	As many as there are excludeaddressranges elements (0 or more elements for each excludeaddressranges element).
end	Description	The end address of the excluded addresses.
	Type	string
	Number of occurrences	As many as there are excludeaddressrange elements (0 or 1 element for each excludeaddressrange element).
start	Description	The leading address of the excluded addresses.
	Type	string
	Number of occurrences	As many as there are excludeaddressrange elements (0 or 1 element for each excludeaddressrange element).
name	Description	L-Platform name.
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
networkCategory	Description	Network type. For manager LAN, the value is "MANAGEMENT". For business LAN, the value is "BUSINESS". If the network has not been registered, the value is an empty string.
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
networkId	Description	Network ID.
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
numOfMaxVm	Description	Maximum number of VMs.
	Type	int
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
resourceId	Description	Network resource ID.
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
segmentType	Description	Segment type information.
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).

Sample response

<?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>