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------------------------------------------------+ |   
                      |                           +-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 will result in adding ServerA to port 80 on all clusters:
    dscontrol server add @80@ServerA
    Note: Additional 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 will result in adding ServerA to all clusters on all ports:
    dscontrol server add @@ServerA
    Note: Additional 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: Additional 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 located 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
  • fixedweight
    The fixedweight option allows you to specify whether you want the manager to modify the server weight or not. If you set the fixedweight value to yes, when the manager runs it will not be allowed to modify the server weight. For more information, see Managing traffic with server weights.
    • value

      Specifies the value of fixedweight. The value can be yes or no. Default is no.

    • 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 forwarding client requests to the server by the dispatcher when using 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 using 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. This is the 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 will prevent any new requests from being sent to the server, but will 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 will be 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

Reference topic    

Terms and conditions for information centers | Feedback

Last updated: April 16, 2014 11:59 AM EDT
File name: rcmd_dscontrolserv.html