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-------------------+       |   
                    |      +-cluster@port@server--reset--+-yes-+-+       |   
                    |      |                             '-no--' |       |   
                    |      +-staletimeout--value-----------------+       |   
                    |      +-weightbound--value------------------+       |   
                    |      '-selectionalgorithm--+-connection-+--'       |   
                    |                            +-affinity---+          |   
                    |                            '-conn+affin-'          |   
                    +-set--+-cluster@port--repstrategy--+-both-------+-+-+   
                    |      |                            +-connection-+ | |   
                    |      |                            +-affinity---+ | |   
                    |      |                            '-none-------' | |   
                    |      +-port--reset--+-yes-+----------------------+ |   
                    |      |              '-no--'                      | |   
                    |      +-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.
  • cluster@port repstrategy value:

    Specifies that connection and affinity records will be replicated between high availability partners. When the records are replicated, connection and affinity states are preserved so that the connections can continue even after takeover has taken place.

    Value can be:
    • both

      Replicate both connection and affinity records.

    • affinity

      Replicate affinity records only.

    • connection

      Replicate connection records only.

    • none

      No replication.

reset
Activate or deactivate the TCP reset feature. Load Balancer will send a TCP reset to the client when the client has a connection to a server with a weight of 0. A server's weight can be 0 if it is configured to 0 or if an advisor marks the server down. A TCP reset will cause the connection to be immediately closed.
Avoid trouble Avoid trouble: Be aware of the following:
  • Load Balancer will not send a TCP reset command when all backend servers are down.
  • To use TCP reset, you must set the clientgateway for IPv4 addresses, or clientgateway6 for IPV6 addresses, to a router address. Use the dscontrol executor command. Clientgateway has to be set for a port that is on IPv4 cluster, and clientgateway6 has to be set on a port that is on IPv6 cluster.
gotcha
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

  • To set the selection algorithm for a port:
    dscontrol port add cluster@port selectionalgorithm affinity
  • To add port 80 and 23 to a cluster address 130.40.52.153:
    dscontrol port add 130.40.52.153@80+23
  • To set the maximum weight of 10 to port 80 at a cluster address of 130.40.52.153:
    dscontrol port set 130.40.52.153@80 weightbound 10
  • To set the stickytime value to 60 seconds for port 80 and port 23 at a cluster address of 130.40.52.153:
    dscontrol port set 130.40.52.153@80+23 stickytime 60
  • To set the cross port affinity of port 80 to port 23 at a cluster address of 130.40.52.153:
    dscontrol port add 130.40.52.153@80 crossport 23
  • To activate TCP reset feature for port 80:
    dscontrol port set 80 reset yes
  • To remove port 23 from a cluster address of 130.40.52.153:
    dscontrol port remove 130.40.52.153@23
  • To get the status of port 80 at a cluster address of 9.67.131.153:
    dscontrol port status 9.67.131.153@80
  • To get the report of port 80 at a cluster address of 9.62.130.157:
    dscontrol port report 9.62.130.157@80
  • To enable connection record replication for high availability partners:
    dscontrol port set 130.40.52.153@23 repstrategy connection

Icon that indicates the type of topic Reference topic



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