2.1.8 ListNetworkResource (Obtain a List of Network Resources)

This API obtains a list of network resources.

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 "ListNetworkResource".
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
[networkCategory]	Description	Network type. A network resource of the specified network type is obtained.
	Type	string
	Value	Specify one of the following: - MANAGEMENT: A network resource with MANAGEMENT specified as the network type is obtained. - BUSINESS: A network resource with BUSINESS specified as the network type is obtained. All network resources are obtained if this is not specified.
[segmentType]	Description	Segment identifier information. A network resource matching that registered in the segment identifier information is obtained.
	Type	string
	Value	No more than 32 characters
[showTenant]	Description	Tenant name display options
	Type	string
	Value	Specify one of the following values: - true: Display of tenant name. - false: No display of tenant name. When omitted, "false" is assumed.

Response

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

<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <networks>
    <network>
      <addressSet>
        <end>[End address of the address set]</end>
        <mask>[Net mask of the address set]</mask>
        <name>[Address set name]</name>
        <start>[Beginning address of the address set]</start>
        <subnet>[Subnet address of the address set]</subnet>
      </addressSet>
      <addressSetStatus>
        <avail>[Number of available addresses in the address set]</avail>
        <num>[Number of addresses in the address set]</num>
        <used>[Number of reserved addresses in the address set]</used>
      </addressSetStatus>
      <excludeaddressranges>
        <excludeaddressrange>
          <start>[Beginning address of the exclude address]</start>
          <end>[End address of the exclude address]</end>
        </excludeaddressrange>
      </excludeaddressranges>
      <comment>[comment]</comment>
      <gateway>[Default gateway]</gateway>
      <locked>[Flag indicating whether the network resource is locked]</locked>
      <networkCategory>[Network type]</networkCategory>
      <resourceId>[network resource ID]</resourceId>
      <resourceName>[network resource name]</resourceName>
      <resourceType>[Network resource type]</resourceType>
      <segmentType>[Segment identifier information]</segmentType>
      <tenantName>[Tenant name of the network resource pool]</tenantName>
      <vlanId>[VLANID]</vlanId>
    </network>
  </networks>
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
</ListNetworkResourceResponse>

Element name	Item	Item description
ListNetworkResourceResponse	Description	Element holding the response information
	Type	None
	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	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
end	Description	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	Net mask 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	Beginning 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	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	Status information of the address set
	Type	None
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
avail	Description	Number of available addresses in the address set
	Type	string
	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	string
	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	string
	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 exclude 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 exclude address information
	Type	None
	Number of occurrences	As many as there are excludeaddressranges elements (0 or more elements for each excludeaddressranges element).
start	Description	Beginning address of the exclude address
	Type	string
	Number of occurrences	As many as there are excludeaddressrange elements (0 or 1 element for each excludeaddressrange element).
end	Description	End address of the exclude address
	Type	string
	Number of occurrences	As many as there are excludeaddressrange elements (0 or 1 element for each excludeaddressrange element).
comment	Description	comment
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
gateway	Description	Default gateway
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
locked	Description	Resource locked status. Flag indicating whether the network resource is locked for DR. - true: locked - false: unlocked When tag does not exist, it is unlocked. The following limitation applies to locked network resources: - An error occurs if an L-Platform template that contains a locked network resource is used with CreateLPlatform. - An error occurs if a locked network resource is added to an L-Platform using CreateNetwork. - An error occurs if a server connected to a locked network resource is added using CreateLServer. - An error occurs if an NIC is added to a locked network resource using CreateNic.
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
networkCategory	Description	Network type
	Type	string
	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).
resourceName	Description	Network resource name
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
resourceType	Description	Network resource type
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
segmentType	Description	Segment identifier information
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
tenantName	Description	Tenant name of the network resource pool
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
vlanId	Description	VLANID
	Type	string
	Number of occurrences	As many as there are network elements (0 or 1 element for each network element).
responseMessage	Description	Message. This element indicates whether the request has been processed correctly. Refer to "Chapter 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

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListNetworkResourceResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <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/>
      <locked>true</locked>
      <networkCategory>BUSINESS</networkCategory>
      <resourceId>network-t-0001</resourceId>
      <resourceName>tenantA-DMZ</resourceName>
      <segmentType>DMZ</segmentType>
      <tenantName>tenantA</tenantName>
      <vlanId>11</vlanId>
    </network>
  </networks>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</ListNetworkResourceResponse>