IBM Tivoli Monitoring > Version 6.3 Fix Pack 2 > Administrator's Guide > Agent-based services > Agent Service Interface > Agent Service Interface - Service Interface Request
IBM Tivoli Monitoring, Version 6.3 Fix Pack 2
Agent Service Interface request - Configuration control
The Service Interface Request can be used to process configuration load list requests.
Authorization
The Service Interface Request recognizes the complete configuration load list XML syntax. The requests that are allowed depend on group permissions:
- If your user ID is a member of the Operation group in the Access Authorization Group Profile (AAGP), you can use the <CNFGCOMMAND> element to refresh files using an existing configuration load list, and can issue <CNFGACTION> Reboot, Reload, and Download requests.
- If your user ID is a member of the Administrative group in the AAGP, you can submit any valid configuration load list request using the syntax in the Configuration load list XML specification.
Elements
The elements and their attributes are case-insensitive. For example, you can enter <CNFGCOMMAND>, <CnfgCommand>, or <cnfgcommand>.
- <CNFGCOMMAND>
- Specify configuration command request. The following example of a configuration control request reloads the contents of the current configuration load list:
<CNFGCOMMAND> <CNFGACTION>RELOAD</CNFGACTION> </CNFGCOMMAND>
- <CNFGACTION>
- Specify the configuration command action:
- Reboot
- This attribute downloads the configuration load list.
- Reload
- Reload is used to perform an immediate resend of the current agent load list, thereby downloading all specified agent artifacts if they have been updated. See the example under <CnfgCommand>.
- Download
- Download is used to specify the file to send. See the examples under <CnfgFile> and <CnfgDisp>.
- <CNFGFILE>
- Optional. Specific last two segments of file name when <CNFGACTION> is Download.
- File name must exist in the load list. Download file alert.txt
<CNFGCOMMAND> <CNFGACTION>DOWNLOAD</CNFGACTION> <CNFGFILE>alert.txt</CNFGFILE> </CNFGCOMMAND>
- <CNFGDISP>
- Optional. Specific well-known configuration file disposition as identification of file name when <CNFGACTION> is Download. The file definition must exist in load list. The following example request downloads the private situation configuration XML file:
<CNFGCOMMAND> <CNFGACTION>DOWNLOAD</CNFGACTION> <CNFGDISP>PVTSIT</CNFGDISP> </CNFGCOMMAND>
- <STATUS>
- Use this element to return the status code within the beginning <status> and ending </status> tags. The following example causes the agent to return the command status:
<CNFGCOMMAND> <STATUS>600 - Configuration control command completed successfully </STATUS> </CNFGCOMMAND>
Parent topic:
Agent Service Interface - Service Interface RequestRelated reference:
Access Authorization Group Profile