Child pages
  • UAPI Functions - Mysql::add_host_note

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

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


Warning
titleImportant:
  • If you attempt to add a note to an unauthorized remote MySQL® server, the function will fail.
  • 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.


Panel
bgColor#F2F2F2
borderStylenone

Example


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Mysql/add_host_note?host=remote.example.com&note=You%20are%20looking%20at%20now

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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'
    )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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'
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Mysql add_host_note host=remote.example.com note='You are looking at now'

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
  },
  "data": null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
hoststring

Required

The remote MySQL server's hostname.

A remote MySQL hostname or IP address.

Note
titleNote:

You may use the following IP address formats:

  • 192.0.2.0 — IP address.
  • 192.0.%.% — Range with the percent (%) symbol as a wildcard.
  • 192.0.2.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.