ePages 6.14.0 - DE_EPAGES/FlexProvider/API/ConfigurationServerClient.pm

Package DE_EPAGES::FlexProvider::API::ConfigurationServerClient

Socket communication with ConfigurationServer

Functions

close
configureEpages
getInfoEpages
getPatchLog
new
runPatchOnStore
setCFSPasswd

close

Closes the connection to the ConfigurationServer. #no critic qw(ProhibitAmbiguousNames)

Syntax
$self->close;

configureEpages

Configures ePages store.

Syntax
$Client->configureEpages($Passwd, $hParams);
Input
$Passwd (string)
$Store->get('ConfigurationServerPassword')
$hParams (ref.hash)
parameters for store configuration
Return
$OutData (string)
response body

getInfoEpages

Receives store information.

Syntax
$Client->getInfoEpages($Passwd, $hParams);
Input
$Passwd (string)
$Store->get('ConfigurationServerPassword')
Return
$hParams (ref.hash)
response body dumped in hash

getPatchLog

Receives content of logfile of patching $Store to $Version.

Syntax
$OutData = $Client->getPatchLog($Passwd, $StoreAlias, $Version);
Input
$Passwd (string)
$Store->get('ConfigurationServerPassword')
$StoreAlias (string)
$Store->get('Alias')
$Version (string)
patch version
Return
$OutData (string)
response body

new

Creates a new ConfigurationServerClient object and establish a connection to the ConfigurationServer.

Syntax
$Client = FlexProvider::API::ConfigurationServer->new(
    Address => $Address,
    Port    => $Port
);
Input
%Options (hash)
parameters
  • Address - VM ip adress - string
  • Port - VM port - string
Return
$Client (object)
the new ConfigurationServerClient object

runPatchOnStore

Runs patch $Version on store $StoreAlias.

Syntax
$Status = $Client->runPatchOnStore($Passwd, $StoreAlias, $Version);
Input
$Passwd (string)
$Store->get('ConfigurationServerPassword')
$StoreAlias (string)
$Store->get('Alias')
$Version (string)
patch version
Return
$Status (integer)
0 - success ; else - failue

setCFSPasswd

Updates the ConfigurationServerPassword of the store.

Syntax
$Client->setCFSPasswd($Passwd, $NewPasswd);
Input
$Passwd (string)
$Store->get('ConfigurationServerPassword')
$NewPasswd (string)
new password
Return
$OutData (string)
response body