Distributed Connector 23.4

# GetChildren

Displays the status of connectors that have registered with the Distributed Connector.

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Parameters

Parameter | Description | Required
--- | --- | ---
`CachedHealth` | A Boolean value, default `true`, that specifies whether to query registered connectors to find out whether they are available (responding to actions from the Distributed Connector). To query registered connectors and retrieve their current availability, set this parameter to `false`. If you choose this option, the `GetChildren` action can only return a response after your connectors respond to the queries. To use the status from the cache, set this parameter to `true`. Do not use this option if you have set `EnableConnectorHealthPolling=false`, because the returned status will be `unknown`. | No
`ShowChildHealth` | A Boolean value, default `false`, that specifies whether to show the availability of registered connectors in the response. | No

## Example

    /action=GetChildren

## Response

The following response is from `/action=GetChildren&ShowChildHealth=true`

    <autnresponse xmlns:autn="http://schemas.autonomy.com/aci/">
       <action>GETCHILDREN</action>
       <response>SUCCESS</response>
       <responsedata>
         <healthpolling>true</healthpolling>
         <polltime>10</polltime>
         <children>
           <num_children>1</num_children>
           <child>
             <host>10.0.0.1</host>
             <port>1234</port>
             <dataport>2345</dataport>
             <group>FileSystem</group>
             <priority>0</priority>
             <active>true</active>
             <calls>6</calls>
           </child>
         </children>
       </responsedata>
     </autnresponse>

There is one `<child>` element in the response for each registered connector. This shows the following information:

`host` | The machine that hosts the child connector.
`port` | The ACI port of the child connector.
`dataport` | The dataport of the child connector.
`group` | The connector group that the child connector has joined.
`priority` | The priority assigned to the child connector within the connector group.
`active` | A Boolean value that indicates whether the child connector is available (responding to actions from the Distributed Connector).
`calls` | The number of requests made to the child connector since it registered with the Distributed Connector.

Copyright 2023 Open Text
Version 23.4 | Last updated September 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Distributed Connector 23.4

Topic Title: GetChildren