Child pages
  • UAPI Functions - Mysql::get_host_notes

Versions Compared

Key

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

Description

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledMySQLRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


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

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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Mysql get_host_notes

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "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"
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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
titleNote:

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



host

string

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

Tip
titleReminder:

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