1.8.3 Creating a collector

This section describes the format of the request to be used for creating the collector and the method for creating a request body.

Procedure

1. Determine the type of collector (such as VCENTER or AJS) is to be created.

2. Acquire a collector that has the same type as the one that you want to create, so that the acquired collector can be used as a template. Issue a request in the following format:

   GET http://host:port/Analytics/version/objects/Collectors

3. Edit the authentication information (Collectors resource, CollectorCredential resource) that you acquired in step 2 according to the table below.

   Table 1‒3: Changes to the Collector resource

   Member to change	Whether the change is required	Description
   name	Required	Change the name to the name of the collector that you want to create. You must specify a name that does not exist among the collectors that are already registered.
   osType	Optional	Specify the type of the OS that is to be monitored.
   collectorCredentials	Optional	Specify the authentication information that is used to connect to the target to be monitored. See the table below for the description.

   Table 1‒4: Changes to the CollectorCredential resource

   Member to change	Whether the change is required	Description
   ipAddress	Optional	Specify the IP address or the host name that is used to connect to the management software.
   userId	Optional	Specify the user ID that is used to connect to the management software.
   password	Optional	Specify the password that is used to connect to the management software.
   portNumber	Optional	Specify the port number that is used to connect to the management software.
   hypertextTransferProtocolType	Optional	This item can be specified only when the collector type is VCENTER. Specify HTTPS.
   domainName	Optional	This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify a domain name.
   rootPassword	Optional	This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Unix. Specify the root password.
   useAdministrativeShares	Optional	This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify true to use administrative shares. When true is specified, there is no need to specify shareName and sharedFolder.
   shareName	Optional	This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify a shared name. This item is enabled only when useAdministrativeShares is false.
   sharedFolder	Optional	This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify the path to the shared folder. This item is enabled only when false is specified for useAdministrativeShares.

4. Issue a request in the following format. In the request body, specify the collector that you edited in step 3.

   POST http://host:port/Analytics/version/objects/Collectors

To Page Top