sync.hub
Description
Contains methods to set up and manage Hub Inter-Server synchronization
Namespace:
sync.hub
Method: addPeripheralChannelsToSync
HTTP POST
Description:
Add peripheral channels to synchronize on a peripheral server
Parameters:
-
string sessionKey
-
[. string ]# string # fqdn - The FQDN identifying the peripheral server
-
array " channelLabels "
-
string "label" - The channel label
-
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: addPeripheralChannelsToSync
HTTP POST
Description:
Add peripheral channels to synchronize on a peripheral server, forcing the peripheral org in custom channels
Parameters:
-
string sessionKey
-
string fqdn - The FQDN identifying the peripheral server
-
array "channelLabels"
-
string "label" - The channel label
-
-
int "peripheralOrgIdWhenCustomChannel" - ID of the peripheral Org to be set in custom channels
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: deregister
HTTP POST
Description:
De-register the server locally identified by the fqdn.
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote server to de-register
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: deregister
HTTP POST
Description:
De-register the server identified by the fqdn.
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote server to de-register
-
boolean onlyLocal - true if the de - registration has to be performed only this server, false to instead fully deregister on both sides
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: generateAccessToken
HTTP POST
Description:
Generate a new access token for ISS for accessing this system
Parameters:
-
string sessionKey
-
string fqdn - FQDN of the peripheral/hub that will be using this access token
Returns:
-
string The serialized form of the token
Method: getAllPeripheralChannels
HTTP GET
Description:
Remotely collect data about peripheral channels
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct channel info
-
long "id" - the id of the channel
-
string "name" - the name of the channel
-
boolean "label" - the label of the channel
-
string "summary" - the summary of the channel
-
long "org_id" - the organization id of the channel
-
long "parent_channel_id" - the parent channel ID of the channel
-
Method: getAllPeripheralOrgs
HTTP GET
Description:
Remotely collect data about peripheral organizations
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct org info
-
long "org_id" - org identifier
-
string "org_name" - org name
-
Method: getManagerInfo
HTTP GET
Description:
Get manager info.
Parameters:
-
string sessionKey
Returns:
-
* struct manager info
-
string "version" - version
-
boolean "report_db" - true if there is a report database
-
string "report_db_name" - name of the report database
-
string "report_db_host" - hostname of the report database
-
int "report_db_port" - port of the report database
-
Method: isISSPeripheral
HTTP POST
Description:
Check if this server is configured as peripheral server and read data from a Hub
Parameters:
-
string sessionKey
Returns:
-
boolean peripheral - True if this is an ISS peripheral, false otherwise
Method: listPeripheralChannelsToSync
HTTP POST
Description:
Lists current peripheral channel to synchronize on a peripheral server
Parameters:
-
string sessionKey
-
[. string ]# string # fqdn - The FQDN identifying the peripheral server
Returns:
-
array :
-
string "label" - Label of a peripheral channel to sync
-
Method: migrateFromISSv1
HTTP POST
Description:
Migrate the existing ISSv1 slaves to Hub Online Synchronization peripherals.
Parameters:
-
string sessionKey
-
array migration_data
-
struct slave_migration_data
-
string "fqdn" - The fully qualified domain name of the remote slave server.
-
string "token" - The token used to authenticate on the remote server.
-
string "root_ca" - The root ca needed to establish a secure connection to the remote server.
-
-
Returns:
-
* struct result
-
array "messages"
-
struct message
-
string "severity" - the severity of the message
-
string "message" - the message
-
-
-
result_code "success"
-
Method: migrateFromISSv2
HTTP POST
Description:
Migrate the existing ISSv2 peripherals to Hub Online Synchronization peripherals.
Parameters:
-
string sessionKey
-
array migration_data
-
struct peripheral_migration_data
-
string "fqdn" - The fully qualified domain name of the remote peripheral server.
-
string "token" - The token used to authenticate on the remote server.
-
string "root_ca" - The root ca needed to establish a secure connection to the remote server.
-
-
Returns:
-
* struct result
-
array "messages"
-
struct message
-
string "severity" - the severity of the message
-
string "message" - the message
-
-
-
result_code "success"
-
Method: regenerateSCCCredentials
HTTP POST
Description:
Regenerate the username and the password for an existing peripheral.
Parameters:
-
string sessionKey
-
[. string ]# string # fqdn - The FQDN identifying the peripheral server
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: registerPeripheral
HTTP POST
Description:
Registers automatically a remote server with the specified ISS role.
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote server to register
-
string username - the name of the user, needed to access the remote server It must have the sat admin role
-
string password - the password of the user, needed to access the remote server
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: registerPeripheral
HTTP POST
Description:
Registers automatically a remote server with the specified ISS role.
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote server to register
-
string username - the name of the user, needed to access the remote server It must have the sat admin role
-
string password - the password of the user, needed to access the remote server
-
string rootCA - the root CA certificate, in case it’s needed to establish a secure connection
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: registerPeripheralWithToken
HTTP POST
Description:
Registers a remote server with the specified ISS role using an existing specified access token.
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote server to register
-
string token - the token used to authenticate on the remote server.
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: registerPeripheralWithToken
HTTP POST
Description:
Registers a remote server with the specified ISS role using an existing specified access token.
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote server to register
-
string token - the token used to authenticate on the remote server.
-
string rootCA - the root CA certificate, in case it’s needed to establish a secure connection
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: removePeripheralChannelsToSync
HTTP POST
Description:
Remove peripheral channels to synchronize on a peripheral server
Parameters:
-
string sessionKey
-
[. string ]# string # fqdn - The FQDN identifying the peripheral server
-
array " channelLabels "
-
string "label" - The channel label
-
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: replaceTokens
HTTP POST
Description:
Replace the auth tokens for connections between this hub and the given peripheral server
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the remote peripheral server to replace the tokens
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: setDetails
HTTP POST
Description:
Set server details. All arguments are optional and will only be modified if included in the struct.
Parameters:
-
string sessionKey
-
string fqdn - The FQDN of Hub or Peripheral server to lookup details for.
-
string role - The role which should be updated. Either 'HUB' or 'PERIPHERAL'.
-
struct data
-
string "root_ca" - The root ca
-
string "gpg_key" - The root gpg key - only for role HUB
-
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: storeAccessToken
HTTP POST
Description:
Generate a new access token for ISS for accessing this system
Parameters:
-
string sessionKey
-
string fqdn - the FQDN of the peripheral/hub that generated this access token
-
string token - the access token
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: syncPeripheralChannels
HTTP POST
Description:
Synchronize peripheral channels on a peripheral server
Parameters:
-
string sessionKey
-
[. string ]# string # fqdn - The FQDN identifying the peripheral server
-
array " channelLabels "
-
string "label" - The channel label
-
Returns:
-
int - 1 on success, exception thrown otherwise.