sscontrol advisor

Use the sscontrol advisor command to control the advisor.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-sscontrol--file--+-delete--filename.ext-----------------------------------+-><
                    +-appendload--filename.ext-------------------------------+   
                    +-report-------------------------------------------------+   
                    +-save--filename.ext-------------------------------------+   
                    +-logsize--name--+-port---------+--+-unlimited---------+-+   
                    |                '-cluster@port-'  '-number of records-' |   
                    +-receivetimeout--name--+-port---------+--seconds--------+   
                    |                       '-cluster@port-'                 |   
                    +-report--save--filename.ext-----------------------------+   
                    '-force--newload--filename.ext---------------------------'   

Read syntax diagramSkip visual syntax diagram
>>-connecttimeout--name--port--sitename@port--seconds----------->

>--interval--name--port--sitename@port--seconds--list----------->

>--loglevel--name--port--sitename@port--level--logsize--name---->

>--port--sitename@port--size | unlimited--bytes----------------->

>--receivetimeout--name--port--sitename@port--seconds--report--->

>--name--port--sitename@port--retries--name--port--------------->

>--sitename@port--numretries--start--name--port----------------->

>--sitename@port--log file--status--name--port--sitename@port--->

>--stop--name--port--sitename@port--timeout--name--port--------->

>--sitename@port--version--name--port--sitename@port--seconds--><

Parameters

connecttimeout
Set how long an advisor waits before reporting that a connect to a server for a particular port on a server (a service) fails. For more information, see the Advisor connect timeout and receive timeout for servers topic.
  • name

    The name of the advisor. Possible values include http, https, ftp, sip, ssl, smtp, imap, pop3, ldap, ldaps, nntp, telnet, connect, ping, WLM, and WTE. Names of customized advisors are of the format xxxx, where ADV_xxxx is the name of the class that implements the custom advisor.

  • port

    The number of the port that the advisor is monitoring.

  • seconds

    A positive integer representing the timeout in seconds at which the advisor waits before reporting that a connect to a server fails. The default is 3 times the value specified for the advisor interval.

interval
Set how often the advisor will query the servers for information.
  • seconds

    A positive integer representing the number of seconds between requests to the servers about their current status. The default is 7.

list
Show list of advisors that are currently providing information to the manager.
loglevel
Set the logging level for an advisor log.
  • level
    The number of the level (0 to 5). The default is 1. The higher the number, the more information that is written to the advisor log. The possible values are:
    • 0 is None
    • 1 is Minimal
    • 2 is Basic
    • 3 is Moderate
    • 4 is Advanced
    • 5 is Verbose
logsize
Set the maximum size of an advisor log. When you set a maximum size for the log file, the file will wrap; when the file reaches the specified size, the subsequent entries are written from the top of the file, overwriting the previous log entries. Log size cannot be set smaller than the current size of the log. Log entries are time–stamped so you can tell the order in which they were written. The higher you set the log level, the more carefully you should choose the log size, because you can quickly run out of space when logging at the higher levels.
  • size | unlimited

    The maximum size in bytes for the advisor log file. You can specify either a positive number greater than zero, or unlimited. The log file may not reach the exact maximum size before being overwritten because the log entries vary in size. The default value is 1 MB.

receivetimeout
Set how long an advisor waits before reporting that a receive from a particular port on a server (a service) fails.
  • seconds

    A positive integer representing the timeout in seconds at which the advisor waits before reporting that a receive from a server fails. The default is 21 seconds.

report
Display a report on the state of the advisor.
retries
The number of retries that an advisor can make before marking a server down.
  • numretries

    An integer greater than or equal to zero. This value should be no larger than 3. If retries keyword is not configured, the number of retries defaults to zero.

start
Start the advisor. There are advisors for each protocol. The default ports are as follows:
Table 1. Default ports for advisors
Advisor name Protocol Port
connect n/a user-defined
db2 private 50000
ftp FTP 21
http HTTP 80
https SSL 443
imap IMAP 143
ldap LDAP 389
nntp NNTP 119
ping PING n/a
pop3 POP3 110
sip SIP 5060
smtp SMTP 25
ssl SSL 443
telnet Telnet 23
name

The advisor name.

sitename@port

The sitename value is optional on the advisor commands; however, the port value is required. If the sitename value is not specified, the advisor starts running on all available site names configured. If you specify a site name, the advisor starts running for only the site name you specify. Additional site names are separated by a plus sign (+).

  • log file

    File name to which the management data is logged. Each record in the log is time–stamped.

    The default file is advisorname_port.log, for example, http_80.log. To change the directory where the log files are kept, see the Changing the log file paths topic.

    You can start only one advisor for each site name.

status
Display the current status of all the values in an advisor that can be set globally and their defaults.
stop
Stop the advisor.
timeout
Set the number of seconds for which the manager will consider information from the advisor as valid. If the manager finds that the advisor information is older than this timeout period, the manager will not use that information in determining weights for the servers on the port the advisor is monitoring. An exception to this timeout is when the advisor has informed the manager that a specific server is down. The manager will use that information about the server even after the advisor information has timed out.
  • seconds

    A positive number representing the number of seconds, or the word unlimited. The default value is unlimited.

version
Display the current version of the advisor.

Samples

  • To set the time (30 seconds) an HTTP advisor (for port 80) waits before reporting that a connect to a server fails:
    sscontrol advisor connecttimeout http 80 30
  • To set the interval for the FTP advisor (for port 21) to 6 seconds:
    sscontrol advisor interval ftp 21 6
  • To display the list of advisors currently providing information to the manager:
    sscontrol advisor list
    This command produces output similar to:
    --------------------------------------- 
    | ADVISOR | SITENAME@PORT |  TIMEOUT  |
    ---------------------------------------
    |  http   |            80 | unlimited |
    |  ftp    |            21 | unlimited |
    --------------------------------------- 
  • To change the log level of the http advisor log for the site name of mysite to 0 for better performance:
    sscontrol advisor loglevel http mysite@80 0
  • To change the ftp advisor log size for the site name of mysite to 5000 bytes:
    sscontrol advisor logsize ftp mysite@21 5000
  • To set the time (60 seconds) an HTTP advisor (for port 80) waits before reporting that a receive from a server fails:
    sscontrol advisor receivetimeout http 80 60
  • To display a report on the state of the ftp advisor (for port 21):
    sscontrol advisor report ftp 21
    This command produces output similar to:
    Advisor Report:
    ---------------
    Advisor name ............. http
    Port number .............. 80
    
    sitename ................. mySite
    Server address ........... 9.67.129.230
    Load ..................... 8
  • To start the advisor with theftpadv.log file:
    sscontrol advisor start ftp 21 ftpadv.log
  • To display the current status of values associated with the http advisor:
    sscontrol advisor status http 80
    This command produces output similar to the following:
    Advisor Status:
    ---------------
    Interval (seconds) ............ 7
    Timeout (seconds) ............. Unlimited
    Connect timeout (seconds).......21
    Receive timeout (seconds).......21
    Advisor log filename .......... Http_80.log
    Log level ..................... 1
    Maximum log size (bytes) ...... Unlimited
    Number of retries ............. 0
  • To stop the http advisor at port 80:
    sscontrol advisor stop http 80
  • To set the timeout value for advisor information to 5 seconds:
    sscontrol advisor timeout ftp 21 5
  • To find out the current version number of the ssl advisor:
    sscontrol advisor version ssl 443

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: March 23, 2018 0:18
File name: rcmd_sscontroladvisor.html