Child pages
  • UAPI Functions - Mysql::get_host_notes
Skip to end of metadata
Go to start of metadata

Description

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

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/get_host_notes


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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'
);


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.
 
# Get Mysql host notes.
my $get_server_information = $cpliveapi->uapi(
    'Mysql', 'get_host_notes'
);


Note:

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

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


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Mysql get_host_notes


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "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"
   }
}


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

ReturnTypeDescriptionPossible valuesExample

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

This hash contains the host return.

Note:

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


host

string

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

Reminder:

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
  • No labels