REST API - find

REST API - find

com.vmware.vcenter.inventory.network

The network service provides operations to retrieve information about vCenter Server networks.

find

POST /com/vmware/vcenter/inventory/network?~action=find

Returns network information for the specified vCenter Server networks. The key in the result key/value pairs is the network identifier and the value in the key/value pairs is the network information.
Request:
Representations:
{
    "networks": [
        "obj-103",
        "obj-103"
    ]
}
<?xml version="1.0" ?>
<ns0:Find-Input xmlns:ns0="http://vmware.com/vcenter/inventory/network" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <networks-array>
    <array-item>obj-103</array-item>
    <array-item>obj-103</array-item>
  </networks-array>
</ns0:Find-Input>
POST /com/vmware/vcenter/inventory/network?~action=find
&networks.1=obj-103
&networks.2=obj-103

Parameters:
Name Type Required Description
networks
 *
 List<ID> Yes Identifiers of the vCenter Server networks for which information will be returned. Id of type Network.

Response:
Representations:
{
    "value": [
        {
            "key": "obj-103",
            "value": {
                "type": "string"
            }
        }
    ]
}
<?xml version="1.0" ?>
<ns0:Find-Result xmlns:ns0="http://vmware.com/vcenter/inventory/network" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <value>
        <type>string</type>
      </value>
      <key>obj-103</key>
    </array-item>
  </value-array>
</ns0:Find-Result>

Parameters:
Name Type Required Description
result Map<ID, Optional<info>> Yes Network information for the specified vCenter Server networks. The key in the result key/value pairs is the network identifier and the value in the key/value pairs is the network information. Id of type Network.

Errors:
Type Description HTTP Status Code
not_found if no datastore can be found for one or more of the vCenter Server network identifiers in networks 404

Copyright © 2014. All Rights Reserved.