dscontrol manager

You can control the manager function with the dscontrol manager command.

Syntax

Read syntax diagramSkip visual syntax diagram dscontrol manager intervalsecondsloglevellevellogsizeunlimitedbytesmetric setloglevellevellogsizeunlimitedbytesquiesceservercluster@port@server?dailystart_hourend_hourreach setintervalsecondssuspendtruefalseloglevellevellogsizeunlimitedbytesrefreshrefresh cyclereport?cluster+cluster2...restartMessagesensitivityweightsmoothingindexstartlog filemetric_portstatusstopunquiesceservercluster@port@serverversion

Parameters

interval
Set how often the manager will update the weights of the servers to the executor, updating the criteria that the executor uses to route client requests.
  • seconds

    A positive number representing in seconds how often the manager will update weights to the executor. The default is 2.

loglevel
Set the logging level for the manager log.
  • level

    The number of the level (0 to 5). The higher the number, the more information that is written to the manager log. The default is 1. 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 the manager 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 beginning 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.
  • bytes

    The maximum size in bytes for the manager 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.

metric set
Sets the loglevel and logsize for the metric monitor log. The loglevel is the metric monitor logging level (0 - None,1 - Minimal,2 - Basic,3 - Moderate, 4 - Advanced, or 5 - Verbose). The default log level is 1. The log size is the maximum number of bytes to be logged in the metric monitor log file. You can specify either a positive number greater than zero, or unlimited. The default logsize is 1 MB.
quiesce
Specify no more connections to be sent to a server except subsequent new connections from the client to the quiesced server if the connection is designated as sticky and stickytime has not expired. The manager sets the weight for that server to 0 in every port to which it is defined. Use this command if you want to do some quick maintenance on a server and then unquiesce it. If you delete a quiesced server from the configuration and then add it back, it will not retain its status prior to being quiesced. For more information, see Quiesce servers or services for maintenance windows.
server
The IP address of the server as either a symbolic name or in dotted decimal format.
cluster@port@server
When you want to bring down a particular service on a server, like HTTP, you can now quiesce individual daemons. If you have added server1 to port 80 and port 22 of a cluster, for example, the usual quiesce command will stop forwarding traffic to server1 on port 80 and port 22. This new option allows you to stop traffic only on port 80 if you need to stop that particular service.
daily start_hour end_hour
This setting specifies to quiesce the server at a time of day, start_hour, and unquiesce the server at a later point, end_hour. The values for start_hour and end_hour are can range from 0 to 23. For example, (1 2) indicates to quiesce the server from 1:00 AM to 2:00 AM. (12 13) indicates to quiesce the server from 12:00 PM to 1:00 PM, which is a 1 hour period. Specify (-1 -1) to disable the daily quiesce for a particular server.
reach set
Sets the interval, loglevel, and logsize for the reach advisor. To disable monitoring of reach targets, set suspend to true.
refresh
Set the number of intervals before querying the executor for a refresh of information about new and active connections.
  • refresh cycle

    A positive number representing the number of intervals. The default is 2.

report
Display a statistics snapshot report.
  • cluster
    The address of the cluster you want displayed in the report. The address can be either a symbolic name or in IP address format. The default is a manager report display for all the clusters.
    Note: Additional clusters are separated by a plus sign (+).
restart
Restart all servers (that are not down) to normalized weights (1/2 of maximum weight).
  • message

    A message that you want written to the manager log file.

sensitivity
Set minimum sensitivity to which weights update. This setting defines when the manager should change its weighting for the server based on external information.
  • weight

    A number from 1 to 100 to be used as the weight percentage. The default of 5 creates a minimum sensitivity of 5%.

smoothing
Set an index that smooths the variations in weight when load balancing. A higher smoothing index will cause server weights to change less drastically as network conditions change. A lower index will cause server weights to change more drastically.
  • index

    A positive floating point number. The default is 1.5.

start
Start the manager.
  • log file

    File name to which the manager data is logged. Each record in the log is time stamped. The default file is installed in the logs directory. See Examples. To change the directory where the log files are kept, see information about logging with Load Balancer.

  • metric_port

    Port that Metric Server will use to report system loads. If you specify a metric port, you must specify a log file name. The default metric port is 10004.

status
Display the current status of all the values in the manager that can be set globally and their defaults.
stop
Stop the manager.
unquiesce
Specify that the manager can begin to give a weight higher than 0 to a server that was previously quiesced, in every port to which it is defined.
  • server

    The IP address of the server as either a symbolic name or in dotted decimal format.

  • cluster@port@server

    This command will unquiesce that particular port for service, but all other ports will remained quiesced.

version
Display the current version of the manager.

Samples

  • To set the updating interval for the manager to every 5 seconds:
    dscontrol manager interval 5
  • To set the level of logging to 0 for better performance:
    dscontrol manager loglevel 0
  • To set the manager log size to 1,000,000 bytes:
    dscontrol manager logsize 1000000
  • To specify that no more connections be sent to the server at 130.40.52.153:
    dscontrol manager quiesce 130.40.52.153
  • To quiesce the HTTP service on server 9.40.25.67, which is on cluster1:
    dscontrol manager quiesce cluster1@9.40.25.67@80
  • To set the number of updating intervals before the weights are refreshed to 3:
    dscontrol manager refresh 3
  • To get a statistics snapshot of the manager:
    dscontrol manager report
  • To restart all the servers to normalized weights and write a message to the manager log file:
    dscontrol manager restart Restarting the manager to update code
  • To set the sensitivity to weight changes to 10:
    dscontrol manager sensitivity 10
  • To set the smoothing index to 2.0:
    dscontrol manager smoothing 2.0
  • To start the manager and specify the log file named ndmgr.log (paths cannot be set):
    dscontrol manager start ndmgr.log
  • To display the current status of the values associated with the manager:
    dscontrol manager status
  • To stop the manager:
    dscontrol manager stop
  • To specify that no more new connections be sent to a server at 130.40.52.153 between 2:00 AM and 4:00 PM:
    dscontrol manager quiesce 130.40.52.153 daily 2 16
  • To specify that the manager can begin to give a weight higher than 0 to a server at 130.40.52.153 that was previously quiesced:
    dscontrol manager unquiesce 130.40.52.153
  • To display the current version number of the manager:
    dscontrol manager version