Child pages
  • UAPI Functions - KnownHosts::update

Versions Compared

Key

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

Description

Excerpt
This function updates an entry in the /home/user/.ssh/known_hosts file.


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/KnownHosts/update?host_name=host.example.com

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// update the host
$update = $cpanel->uapi(
    'KnownHosts', 'update',
     array(
        'host_name'    => 'host.example.com';
     )
);

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.
 
# update the host
my $update = $cpliveapi->uapi(
    'KnownHosts', 'update',    {
        'host_name'    => 'host.example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- update the host. -->
[% data = execute( 
   'KnownHosts', 'update', {
        'host_name'    => 'host.example.com',
   } 
); %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
uapi --user=username KnownHosts update host_name=host.example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "errors":null,
   "data":{

   },
   "status":1,
   "metadata":{  

   },
   "messages":null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
host_namestring

Required

The host to update.

A valid hostname.

example.com

portinteger

The SSH port to use, if the system uses a non-standard SSH port.

If you do not supply a value, the function uses the standard SSH port (22).

A valid port number.1234

 

Returns

This function only returns metadata.