dscontrol server

Configure servers and modify existing server configurations with the dscontrol server command.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-dscontrol--server--+-add--cluster@port@server--+-address--address--------------------------------------------------+-+-><
                      |                           +-advisorrequest--string--------------------------------------------+ |   
                      |                           +-advisorresponse--string-------------------------------------------+ |   
                      |                           +-collocation--+-yes-+----------------------------------------------+ |   
                      |                           |              '-no--'                                              | |   
                      |                           +-encapforward--+-yes-+--encaptype--+-ipip-+--encapcond--+-always-+-+ |   
                      |                           |               '-no--'             '-gre--'             '-auto---' | |   
                      |                           +-fixedweight--value------------------------------------------------+ |   
                      |                           +-mapport--portvalue------------------------------------------------+ |   
                      |                           +-nat--+-yes-+------------------------------------------------------+ |   
                      |                           |      '-no--'                                                      | |   
                      |                           +-returnaddress----address------------------------------------------+ |   
                      |                           +-router----address-------------------------------------------------+ |   
                      |                           +-sticky--+-yes-+---------------------------------------------------+ |   
                      |                           |         '-no--'                                                   | |   
                      |                           '-weight--value-----------------------------------------------------' |   
                      +-set--cluster@port@server--+-advisorrequest--string--------------------------------------------+-+   
                      |                           +-advisorresponse--string-------------------------------------------+ |   
                      |                           +-collocation--+-yes-+----------------------------------------------+ |   
                      |                           |              '-no--'                                              | |   
                      |                           +-encapforward--+-yes-+--encaptype--+-ipip-+--encapcond--+-always-+-+ |   
                      |                           |               '-no--'             '-gre--'             '-auto---' | |   
                      |                           +-fixedweight--value------------------------------------------------+ |   
                      |                           +-nat--+-yes-+------------------------------------------------------+ |   
                      |                           |      '-no--'                                                      | |   
                      |                           +-returnaddress----address------------------------------------------+ |   
                      |                           +-router----address-------------------------------------------------+ |   
                      |                           +-sticky--value-----------------------------------------------------+ |   
                      |                           '-weight--value-----------------------------------------------------' |   
                      +-remove--cluster@port@server---------------------------------------------------------------------+   
                      +-report--cluster@port@server---------------------------------------------------------------------+   
                      '-status--cluster@port@server---------------------------------------------------------------------'   

Parameters

add
Add this server.
  • cluster
    The address of the cluster as either a symbolic name or in IP address format. You can use an at symbol (@) to act as a wild card. For instance, the following command results in adding ServerA to port 80 on all clusters:
    dscontrol server add @80@ServerA
    Note: Extra clusters are separated by a plus sign (+).
    .
  • port
    The number of the port. You can use an at symbol (@) to act as a wild card. For instance, the following command results in adding ServerA to all clusters on all ports:
    dscontrol server add @@ServerA
    Note: Extra ports are separated by a plus sign (+).
  • server
    The server is the unique IP address of the TCP server machine as either a symbolic name or in IP address format. Or, if you use a unique name that does not resolve to an IP address, you must provide the server address parameter on the dscontrol server add command.
    Note: Extra servers are separated by a plus sign (+).
  • address
    The unique IP address of the TCP server machine as either a host name or in IP address format. If the server is not able to be resolved, you must provide the address of the physical server machine.
    • address

      Value of the address of the server.

  • advisorrequest

    String

  • advisorresponse

    String

  • collocation value
    • yes
    • no

    The default value is no.

  • encapforward value
    Specifies to enable encapsulation forwarding. Value can be yes or no.
    New feature New feature:
    Use encapsulation forwarding when the backend server is not on the same network segment or if you are using virtualization technology and need to forward packets that are otherwise unable to be forwarded.newfeat
    • encaptype value
      Specifies the type of encapsulation forwarding. Value can be:
      • ipip
      • gre
    • encapcond value
      Specifies the conditions in which to enable encapsulation forwarding. Value can be:
      • always
      • auto
  • mapport
    Note: The mapport parameter is available only when you use the cbrcontrol command. It is not a valid parameter with the dscontrol command.
    Map the client request's destination port number to the server's port number that Dispatcher uses to load balance the client's request. Allows Load Balancer to receive a client's request on one port and to transmit it to a different port on the server machine. With the mapport parameter, you can load balance a client's requests to a server that might be running multiple server daemons.
    • portvalue

      Value of the map port number. The default is the client request's destination port number.

  • NAT value
    Specifies whether or not NAT is enabled.
    • yes
    • no
  • return address value
    The IP address to use as the source address when you forward client requests to the server by the dispatcher when you use NAT forwarding.
    • address

      Value of the return IP address.

  • router address value
    The IP address of the router to the remote server that is used by the dispatcher when you use the NAT forwarding method.
    • address

      Value of the router IP address.

  • sticky value
    The sticky option allows a server to override the stickytime setting on a specific port. This feature can be useful in certain situations in which you are using rules to control traffic. The sticky option behaves like this:
    • With a default value of yes, the server retains the normal affinity that is defined at the port.
    • With a value of no, the client will not return to that server the next time it issues a request on that port, regardless of the stickytime setting of the port.
    Avoid trouble Avoid trouble: Sticky is valid only for conn+affin port selection algorithm.gotcha
    For more information, see the step on enabling port affinity override in the Optimize connections with client-to-server affinity for the Dispatcher component topic.
    Value can be:
    • yes (Default value)
    • no
  • weight
    A number from 0–100 (but not to exceed the specified port's weightbound value) representing the weight for this server. Setting the weight to zero prevents any new requests from being sent to the server, but does not end any currently active connections to that server. The default is one-half the specified port's maximum weightbound value. If the manager is running, this setting is quickly overwritten.
    • value

      Value of the server weight.

remove
Remove this server.
report
Report on this server. The report contains the following information per server: current number of connections per second (CPS), kilobytes transferred in a one second interval (KBPS), total number of connections (Total), number of connections that are in the active state (Active), number of connections that are in the FIN state (FINed), and number of completed connections (Comp).
set
Set values for this server.
status
Show status of the servers.

Samples

  • To add the server at 27.65.89.42 to port 80 on a cluster address 130.40.52.153:
    dscontrol server add 130.40.52.153@80@27.65.89.42
  • To remove the server at 27.65.89.42 on all ports on all clusters:
    dscontrol server remove @@27.65.89.42
  • To allow the HTTP advisor to query an HTTP URL request HEAD / HTTP/1.0 for server 27.65.89.42 on HTTP port 80:
    dscontrol server set 130.40.52.153@80@27.65.89.42 advisorrequest "\"HEAD / HTTP/1.0\""
  • To show the status for server 9.67.143.154 on port 80:
    dscontrol server status 9.67.131.167@80@9.67.143.154
  • To set the server 27.65.89.42 as nonsticky, which is the port affinity override feature:
    dscontrol server set 130.40.52.153@80@27.65.89.42 sticky no
  • To set the weight to 10 for server 27.65.89.42 at port 80 on cluster address 130.40.52.153:
    dscontrol server set 130.40.52.153@80@27.65.89.42 weight 10
  • To set the server 27.65.89.42 as nonsticky, which enables the port affinity override feature:
    dscontrol server set 130.40.52.153@80@27.65.89.42 sticky no

Icon that indicates the type of topic Reference topic



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