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

Description

This function adds a note about a remote MySQL® server.

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.

Example


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host_note?host=remote.example.com&note=You%20are%20looking%20at%20now


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.
 
// Add a note to a remote host.
$add_host = $cpanel->uapi(
    'Mysql', 'add_host_note',
    array(
        'host'       => 'remote.example.com',
		'note'		 => 'You are looking at now'
    )
);


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.
 
# Add a note to a remote host.
my $add_host = $cpliveapi->uapi(
    'Mysql', 'add_host_note',
    {
        'host'       => 'remote.example.com',
		'note'		 => 'You are looking at now'
    }
);


Note:

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

 cPanel Template Toolkit
<!-- Add a note to a remote host. -->
[% execute('Mysql', 'add_host_note', { host => 'remote.example.com', note => 'You are looking at now'} ) %]


Note:

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

 Command Line
uapi --user=username Mysql add_host_note host=remote.example.com note='You are looking at now'


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": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The remote MySQL server's hostname.

A remote MySQL hostname or IP address.

Note:

You may use the following IP address formats:

  • 192.168.1.6 — IP address.
  • 192.168.%.% — Range with the percent (%) symbol as a wildcard.
  • 192.168.0.0/16 — Range in CIDR format.


remote.example.com
notestring

Required

A note that describes the remote MySQL server.

A valid string.You are looking at now

Returns

This function only returns metadata.