Controller 25.3
Controller Reference

# Command

The action that you want to schedule, in the form of an XML string.

The XML that you specify must have an `<action>` parent tag. The following table describes the attributes that you can use in the `action` tag to specify the action to schedule.

Attribute name | Required | Description
--- | --- | ---
`Action` | Yes | The name of the action to run in the schedule.
`Type` | Yes | The type of action (`ACIAction` or `IndexAction`).
`Host` | Yes | The host of the service to send the action to.
`Port` | Yes | The port to send the action to.
`FirstParam` | No | (Index actions only) The value of the parameter to list directly after the index action name (for example, the backup directory in the `DREBACKUP` index action).
`SSLSectionName` | No | The configuration section in the Controller configuration file that contains the SSL settings to use for the connection to the child service (see Secure Socket Layer Parameters).
`GSSServiceName` | No | The GSS service name of the child service. If you set this attribute, you must set the `Host` attribute to a fully qualified domain name (that is, for GSS authentication you cannot use `localhost`, an IP address, or a host without the domain name, even if these values resolve to the correct server).

The `<action>` tag can contain one or more `<params>` tags. The following table describes the attributes that you can use in the `params` tag to specify parameters to add to the action.

Attribute name | Required | Description
--- | --- | ---
`Name` | Yes | The name of the parameter.
`Value` | Yes | The value of the parameter.

The following XML examples show the XML for sending a `GetStatus` ACI action and a `DREBACKUP` index action.

    <action action="getstatus" type="aciAction" host="localhost" port="5012" sslSectionName="contentssl">
       <params name="responseFormat" value="json"/>
       <params name="maxresults" value="2"/>
    </action>

    <action action="DREBACKUP" type="indexAction" firstparam="backup" host="localhost" port="5013" gssServiceName="CONTENT">
       <params name="format" value="html"/>
    </action>

Actions: | AddSchedule EditSchedule
Type: | XML string
Default: | None
Required: | No
Example: | `action=<action action="getstatus" type="aciAction" host="localhost" port="5012" sslSectionName="contentssl"> <params name="responseFormat" value="json"/> <params name="maxresults" value="2"/> </action>`
See Also: |

Copyright 2015-2025 Open Text
Version 25.3 | Last updated July 2025

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 MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Controller 25.3

Topic Title: Command