Description

This function returns the notes associated with the account's remote MySQL® hosts.

Examples




https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_host_notes



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get Mysql host notes.
$get_server_host_and_version = $cpanel->uapi(
    'Mysql', 'get_host_notes'
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get Mysql host notes.
my $get_server_information = $cpliveapi->uapi(
    'Mysql', 'get_host_notes'
);



<!-- Get Mysql host notes. -->
[% execute('Mysql', 'get_host notes') %]



uapi --user=username Mysql get_host_notes



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  
      "1.2.3.45":"The combination on my luggage",
      "8.8.8.8":"Located on Spaceball 1",
      "12.34.56.78":"Located somewhere in the Ford Galaxy"
   }
}



Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

hashAn unnamed hash that contains remote MySQL hostnames or IP addresses and their corresponding notes.

This hash contains the host return.

The hostname or IP address is the return's name.



host

string

The notes associated with the account's Remote MySQL hosts.

The hostname or IP address is the return's name.

The function returns this value in the unnamed hash.

A valid string.

Located somewhere in the Ford Galaxy