dscontrol port

Configure ports and port settings with the dscontrol port command.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-dscontrol--port--+-add--+-crossport--other_port--------------+-+-><
                    |      +-stickytime--value------------------+ |   
                    |      +-staletimeout--value----------------+ |   
                    |      +-weightbound--value-----------------+ |   
                    |      '-selectionalgorithm--+-connection-+-' |   
                    |                            +-affinity---+   |   
                    |                            '-conn+affin-'   |   
                    +-set--+-stickytime--value---+----------------+   
                    |      +-staletimeout--value-+                |   
                    |      '-weightbound--value--'                |   
                    +-remove--cluster@port------------------------+   
                    +-report--cluster@port------------------------+   
                    '-status--cluster@port------------------------'   

Parameters

add
Add a port to a cluster. You must add a port to a cluster before you can add any servers to that port. If there are no ports for a cluster, all client requests are processed locally. You can add more than one port at one time using this command.
  • crossport

    Crossport affinity allows you to expand the affinity feature across multiple ports so that client requests received on different ports can still be sent to the same server for subsequent requests. For the crossport value, specify the other_port number for which you want to share the cross port affinity feature.

    In order to use this feature, the ports must:
    • Share the same cluster address
    • Share the same servers
    • Use the affinity or conn+aff selection algorithm
    • Have the same stickytime value, which is not zero
    To remove the crossport feature, set the crossport value back to its own port number.
    • other_port: specifies the value of crossport. The default value is the same as its own port number.
  • stickytime value
    The interval between the opening of one connection and the opening of a new connection, during which a client will be sent back to the same server that was used for the first connection. After the stickytime value has elapsed, the client might be sent to a server different from the server that was used for the first connection. If you use affinity as the selection algorithm, the stickytime value is the interval between any two successive packets from the same client.
    Avoid trouble Avoid trouble: stickytime is only valid for the conn+aff and affinity selection algorithms.gotcha
    • value is the value of stickytime in seconds.
  • staletimeout
    The number of seconds during which there can be no activity on a connection before that connection is removed. The default value is 900 for port 21 (FTP) and 259,200 for port 23 (Telnet).
    Avoid trouble Avoid trouble: staletimeout is only valid for the connection and conn+affin selection algorithms.gotcha
    • value

      The value of staletimeout in number of seconds.

weightbound
Set the maximum weight for servers on this port. This affects how much difference there can be between the number of requests the executor will give each server. The default value is 20.
  • weight

    A number from 1–100 representing the maximum weight bound.

selectionalgorithm
Defines the method for selecting the next server.
  • affinity

    Specifies that the server selection is based on client affinity.

  • connection

    Specifies that the server selection is based on simple round-robin selection (default).

  • conn+affin
    New feature New feature:
    Specifies that server selection is based on an existing connection. For new connections, the server selection is based on affinity.newfeat
set
Set the fields of a port.
remove
Remove this port.
report
Report on this port.
status
Show status of servers on this port. If you want to see the status on all ports, do not specify a port with this command, but remember to still include the @ symbol.

Sample

Reference topic    

Terms and conditions for information centers | Feedback

Last updated: September 10, 2012 09:00 AM EDT
File name: rcmd_dscontrolport.html