CCI Request Format 

The request has to be a XML message in the following format:

 

<?xml version="1.0" encoding="UTF-8"?>

<ACC_EXTERNAL_REQUEST>

  <REQUEST_TYPE>

    [1] <!-- (fixed value, reserved for later usage) -->

  </REQUEST_TYPE>

 

  <REQUEST_ID>

    [0...2**32-1]

  </REQUEST_ID>

 

  <REQUEST_TIMESTAMP>

    <!-- Timestamp format: yyyy-mm-dd hh:mm:ss.fffffffff

        (for details see Java Doc)

        Time zone: UTC -->

  </REQUEST_TIMESTAMP>

 

  <SERVICE>

    <SERVICE_ID>

      <!-- ID of the service, like set in the ACC -->

    </SERVICE_ID>

    <COMMAND>

      [START, STOP, RELOCATE]

    </COMMAND>

    <HOST_NAME>

      <!-- Physical host name, string format -->

    </HOST_NAME>

    <SERVICE_FLAGS>

      <FORCE_START_ON_SMALL_SERVER>

        [TRUE, FALSE(default value)]

      </FORCE_START_ON_SMALL_SERVER>

    </SERVICE_FLAGS>

  </SERVICE>

 

  <REPLY_LOG>

    [TRUE, FALSE]

  </REPLY_LOG>

</ACC_EXTERNAL_REQUEST>

 

REQUEST_TYPE tag

Has to be set to 1, reserved for future use.

 

REQUEST_ID tag

Integer number in the range from 0 to 2**32-1. The value of this tag is not analyzed by the ACC and can be used by the program calling the Controller Command Interface for its own purposes.

 

REQUEST_TIMESTAMP tag

Time stamp is in the format yyyy-mm-dd hh:mm:ss.fffffffff . For details please refer to the Java documentation Time Zone UTC. The value of this tag is not analyzed by the ACC and can be used by the program calling the Controller Command Interface for its own purposes.

 

HOST_NAME tag

The internal behavior of the ACC for the commands START and RELOCATE depends on the value of the tag HOST_NAME.

• HOST_NAME is set:
• • START: The ACC will start the requested service on the host <HOST_NAME>.
    If a service is already running on this server, the ACC rejects the command and sets an error value ≠ 0 (this limitation is currently restricted to ACC 1.0).
  • RELOCATE: The ACC will stop the requested service and re-start it on the host <HOST_NAME>.
    The host on which the actual running service has to be stopped is determined by the ACC itself (see also STOP).
    For the host where the service has to be stared, the same rules apply like for START. The ACC checks whether the host is able to run the new service before stopping the service. If the target host is not usable, it does not stop the service and reports a corresponding error code.
• HOST_NAME is not set:
• • START and RELOCATE: The host where to start the service is determined by the internal assignment rules of the ACC.
• HOST_NAME is ignored for the STOP command.
  The host on which the actual running service has to be stopped is determined by the ACC itself.

 

SERVICE_FLAGS tag

The SERVICE_FLAGS tag is optional. It can contain several flag tags inside. If the whole SERVICE_FLAGS tag is not available, all the possible flag tags inside will be taken into account with their default values. Also if a flag tag inside the SERVICE_FLAGS tag is not available, the default value of the flag is taken.

Currently only the flag FORCE_START_ON_SMALL_SERVER is supported. Its values can be TRUE and FALSE (default value).

This flag is used to determine whether the requested service can be started on the requested server even if this server does not meet the SAPS and memory requirements of the service.

The required performance of a service is indicated by the value “Required SAPS”. A service with a “Required SAPS” value of N can not be started on a server which offers M SAPS and N>M normally. The same rule applies for “Required Memory”. With the graphical user interface, the user can overrule this behavior manually. The flag FORCE_START_ON_SMALL_SERVER leads to the same behavior. The following table shows the functionality in detail:

 

FORCE_START_ON_SMALL_SERVER tag	N ≥ M	N < M
TRUE	no effect	service starts
FALSE (default value)	no effect	service does not start, return code 7
not set	no effect	service does not start, return code 7

(M = “Required SAPS”/”Required Physical Memory” of service, N = SAPS of server/Free Memory of server)

REPLY_LOG tag

If the REPLY_LOG is set to TRUE, the ACC includes the complete command log of the requested command in its reply message.