cPanel API 2 Functions - Net::traceroute

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function uses traceroute to retrieve the local IP address.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Net&cpanel_jsonapi_func=traceroute

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve IP address traceroute.
$get_IP_traceroute = $cpanel->api2(
    'Net', 'traceroute'
 );

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve IP address traceroute.
my $get_IP_traceroute = $cpliveapi->api2(
    'Net', 'traceroute',

 );

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Net traceroute

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

                                {
   "cpanelresult" : {
      "apiversion" : 2,
      "data" : [
         {
            "line" : "traceroute to 127.0.0.1 (127.0.0.1), 30 hops max, 60 byte packets"
         },
         {
            "line" : " 1  localhost (127.0.0.1)  0.048 ms  0.013 ms  0.029 ms"
         }
      ],
      "event" : {
         "result" : 1
      },
      "func" : "traceroute",
      "module" : "Net"
   }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
	array of hashes	An array of hashes that contain information about the traceroute results.	This array of hashes includes the `line` return.
`line`	string	The result of the traceroute process. The function returns this value in the unnamed hash.	The `traceroute to` string, the host, the IP address in parenthesis, the maximum amount of time the packet requires to travel to the destination, and the packet size, in bytes.	`traceroute to 10.1.14.78 (10.1.14.78), 30 hops max, 60 byte packets`
`reason`	string	A reason for failure. Note: This function only returns a `reason` value if there was an error.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`