dscontrol advisor

Use this command to control various features of the advisor function.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-dscontrol--advisor--+-connecttimeout--name--+-port---------+--seconds--------+-><
                       |                       '-cluster@port-'                 |   
                       +-interval--name--+-port---------+--seconds--------------+   
                       |                 '-cluster@port-'                       |   
                       +-list---------------------------------------------------+   
                       +-loglevel--name--+-port---------+--level----------------+   
                       |                 '-cluster@port-'                       |   
                       +-logsize--name--+-port---------+--+-unlimited---------+-+   
                       |                '-cluster@port-'  '-number of records-' |   
                       +-receivetimeout--name--+-port---------+--seconds--------+   
                       |                       '-cluster@port-'                 |   
                       +-report--name--+-port---------+-------------------------+   
                       |               '-cluster@port-'                         |   
                       +-retries--name--+-port---------+--number of retries-----+   
                       |                '-cluster@port-'                        |   
                       +-start--name--+-port---------+--------------------------+   
                       |              '-cluster@port-'                          |   
                       +-status--name--+-port---------+--+----------+-----------+   
                       |               '-cluster@port-'  '-log file-'           |   
                       +-stop--name--+-port---------+---------------------------+   
                       |             '-cluster@port-'                           |   
                       +-timeout--name--+-port---------+--+-unlimited-+---------+   
                       |                '-cluster@port-'  '-seconds---'         |   
                       '-version--name--+-port---------+------------------------'   
                                        '-cluster@port-'                            

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 Enabling advisors to manage load balancing.
  • name

    The name of the advisor. Possible values include connect, db2, dns, ftp, http, https, cachingproxy, imap, ldap, ldapuri, nntp, ping, pop3, self, sip, smtp, ssl, ssl2http, telnet, and wlm.

    See the topic List of advisors for more information on the advisors that Load Balancer provides.

    Names of customized advisors are of the format ADV_xxxx, where xxxx is the name of the class that implements the custom advisor. See Creating a custom advisor for more information.

  • port

    The number of the port that the advisor is monitoring.

  • cluster@port

    The cluster value is optional on the advisor commands, but the port value is required. If the cluster value is not specified, then the advisor will start running on the port for all clusters. If you specify a cluster, then the advisor will start running on the port, but only for the cluster you have specified. See the topic Enabling advisors to manage load balancing for more information on starting and stopping advisors.

    The cluster is the address in IP address format or symbolic name. The port is 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 following are the possible values: 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.
  • number of records

    The maximum size in bytes for the advisor log file. You can specify either a positive number greater than zero, or the word unlimited. The log file may not reach the exact maximum size before overwriting because the log entries themselves 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. For more information, see Enabling advisors to manage load balancing.
  • 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 3 times the value specified for the advisor interval.

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

    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 ICMP 12345
db2 private 50000
dns DNS 53
ftp FTP 21
Note: The FTP advisor should advise only on the FTP control port (21). Do not start an FTP advisor on the FTP data port (20).
http HTTP 80
https SSL 443
imap IMAP 143
ldap LDAP 389
ldapuri LDAP 389
nntp NNTP 119
ping PING 0
pop3 POP3 110
self private 12345
sip SIP 5060
smtp SMTP 25
ssl SSL 443
ssl2http SSL 443
telnet Telnet 23
WLM private 10007
  • 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 Logging with Load Balancer. The default log files for cluster (or site) specific advisors are created with the cluster address, for example, http_127.40.50.1_80.log.

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 start the http advisor on port 80 for cluster 127.40.50.1:
    dscontrol advisor start http 127.40.50.1@80
  • To start the http advisor on port 88 for all clusters:
    dscontrol advisor start http 88
  • To stop the http advisor at port 80 for cluster 127.40.50.1:
    dscontrol advisor stop http 127.40.50.1@80
  • To set the time (30 seconds) an HTTP advisor for port 80 waits before reporting that a connect to a server fails:
    dscontrol advisor connecttimeout http 80 30
  • To set the time (20 seconds) an HTTP advisor for port 80 on cluster 127.40.50.1 waits before reporting that a connect to a server fails:
    dscontrol advisor connecttimeout http 127.40.50.1@80 20
  • To set the interval for the FTP advisor (for port 21) to 6 seconds:
    dscontrol advisor interval ftp 21 6
  • To display the list of advisors currently providing information to the manager:
    dscontrol advisor list
  • To change the log level of the advisor log to 0 for better performance:
    dscontrol advisor loglevel http 80 0
  • To change the ftp advisor log size for port 21 to 5000 bytes:
    dscontrol advisor logsize ftp 21 5000
  • To set the time (60 seconds) an HTTP advisor (for port 80) waits before reporting that a receive from a server fails:
    dscontrol advisor receivetimeout http 80 60
  • To display a report on the state of the ftp advisor (for port 21):
    dscontrol advisor report ftp 21
  • To display the current status of values associated with the http advisor for port 80:
    dscontrol advisor status http 80
  • To set the timeout value for the ftp advisor information on port 21 to 5 seconds:
    dscontrol advisor timeout ftp 21 5
  • To display the current version number of the ssl advisor for port 443:
    dscontrol advisor version ssl 443
    This command produces output similar to the following:
    Version: 04.00.00.00 - 07/12/2001-10:09:56-EDT
Reference topic    

Terms and conditions for information centers | Feedback

Last updated: September 12, 2012 11:41 PM EDT
File name: rcmd_dscontroladv.html