Child pages
  • WHM API 1 Functions - get_tcp4_sockets
Skip to end of metadata
Go to start of metadata

Description

This function returns data about the system's transmission control protocol (TCP) IPv4 sockets.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_tcp4_sockets?api.version=1
 Command Line
whmapi1 get_tcp4_sockets


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "payload":[
         {
            "uid":102,
            "dport":443,
            "sport":2087,
            "inode":27171,
            "state":10,
            "rqueue":0,
            "src":"10.0.0.1",
            "wqueue":45,
            "dst":"10.0.0.2"
         }
      ]
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept any parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
payloadarray of hashes

An array of hashes that contains the status of the system's TCP IPv4 sockets.

Each hash contains the dport, dst, inode, rqueue, sport, src, state, uid, and wqueue returns.


dport

integer

The source port that the Linux kernel reports for the socket.

The function returns this value in the payload hash.

A port number.

443

dst

string

The destination IP address.

The function returns this value in the payload hash.

An IPv4 address.10.0.0.2

inode

integer

The inode number the Linux kernel assigned to the socket.

The function returns this value in the payload hash.

A positive integer.

27171

rqueue

integer

The number of bytes in the socket's read buffer.

The function returns this value in the payload hash.

A numeric value, in bytes.

0

sport

integer

The source port number.

The function returns this value in the payload hash.

A valid port number.2087

src

string

The source IP address.

The function returns this value in the payload hash.

An IPv4 address.10.0.0.1

state

integer

The socket's current state, in the Linux kernel's numeric format.

The function returns this value in the payload hash.

A positive integer.10

uid

integer

The socket's user ID (UID).

The function returns this value in the payload hash.

A positive integer102

wqueue

integer

The number of bytes the system is waiting to send.

The function returns this value in the payload hash.

A numeric value, in bytes.

45