ADMCOMMAND


8.7

 

The ADMCOMMAND instruction dispatches a command to a child task to control basic operations. The instruction uses the following format:

 

 

[label]

ADMCOMMAND

{admin},{command},{type},{data},{value}

 

Where:

label

Optional. A Program Execution Label.

admin

Required. A previously defined ADMIN data variable.

command

Required. The command to execute.

type

Required. The type of information sent.

data

Required. The data to filter the request.

value

Required. A command setting.

Flags Affected: ZERO

Note the following:

  1. {command} is a number or keyword as defined in ADMEQU.INC indicating the type of action. Valid values are:
     

  2. Value

    Label

    The action is to ...

    1

    $ADMCMDSOFTTERM

    soft terminate the specified task. The task will terminate at next instruction.

    2

    $ADMCMDHARDTERM

    hard terminate the specified task (not recommended). This will lose some resources until the server is totally shutdown. For a Windows server, this also can leave file handles opened indeterminately. Any such lost resources can only be recovered when a server main task is unloaded.

    3

    $ADMCMDLOGGINGON

    turn logging on for the specified task.

    4

    $ADMCMDLOGGINGOFF

    turn logging off for the specified task.

    5

    $ADMCMDSETLOGLEVEL

    set the logging level from zero to two for the specified task. Level zero logs error and basic information. Levels one and two are reserved for future releases.

    6

    $ADMCMDSETADMFLAGS

    set admin flags ({value} must be numeric).

    7

    $ADMCMDSHUTDOWNLOGON

    shutdown the admin logon task used by remote clients. Local admin clients are still permitted to log on. The server must be restarted to allow subsequent ADMLOGONs by remote clients.

    8

    $ADMCMDLOGMSGLEVEL0

    store the {value} data into the server log file with a logging level 0.

    9

    $ADMCMDLOGMSGLEVEL1

    store the {value} data into the server log file with a logging level 1.

    10

    $ADMCMDLOGMSGLEVEL2

    store the {value} data into the server log file with a logging level 2.

    11

    $ADMCMDSETMAILMASK

    set a bit mask to enable/disable certain server mail messages (9.4C). The bit mask {value} must be numeric and the bit definitions are as follows:

    0x1 - Send Data Manager replication errors via an email.

    0x2 - Send email to indicate when users can not logon because the maximum licensed user count has been exceeded for a Data Manager or Application Server.

    0x4 - Send email when a Data Manager or Application Server has started.

    0x8 - Send email when a Data Manager or Application Server has shutdown.

    12

    $ADMCMDSETHTTPMASK

    set a bit mask to enable/disable certain server HTTP behaviors (9.4C). The bit mask {value} must be numeric and the bit definitions are as follows:

     

    0x1 - send GPF data to a Web Server that has been configured for a Data Manager or Application Server.

     

  3. The {type} and {data} parameters select the tasks sent the command.

  4. {type} is a number indicating the class of data that the {data} parameter represents. Valid values are listed in ADMGETINFO.

  5. {data} is specific to the class selected by the {type} parameter. The {data} can specify a single filter operation that determines how the command is be applied. The {data} string may be null to match all characters or it may contain the following:

  6.  

    Generate/bullet1.gif    an asterisk (*) to match a group of characters.

    Generate/bullet1.gif    a question mark (?) to match a single character.

    Generate/bullet1.gif    a leading <, >, =, >=, <=, <> if the type is numeric.

    Example filter usage:

     

    ADM ADMIN

    NULL DIM 1

     

    In this scenario, the soft terminate command is applied to a Sunbelt server child task that has an identification number of 312.

    .

          AdmCommand ADMIN,$ADMCMDSOFTTERM: //Command

                       $ADMITEMADMID: //Type data

                       "=312" //Filter one task

     

    In this scenario, the soft terminate command is applied to a Sunbelt server child task that has an identification number greater than 215.

     

          AdmCommand ADMIN,$ADMCMDSOFTTERM: //Command

                       $ADMITEMADMID: //Type data

                       ">215" //Multiple tasks

    .....

    In this scenario, the soft terminate command is applied to all Sunbelt server child tasks that exist.

          AdmCommand ADMIN,$ADMCMDSOFTTERM: //Command

                       $ADMITEMADMID: //Type data

                       NULL //All child tasks

     

  7. {value} specifies a new setting if the command requires one. For the $ADMCMDSETLOGLEVEL command, {value} is the new logging level.

  8. Currently only a value of zero (0) is supported for $ADMCMDSETLOGLEVEL.

  9. The $ADMCMDSETADMFLAGS command is reserved for future use.

  10. The ZERO flag is set to indicate that the command was syntactically correct. It does not indicate the success or failure of the command.

 

 

See Also: System Interface Instructions

 



PL/B Language Reference System Interface Instructions ADMGETINFO