Click or drag to resize

IInfrascaleClient Interface

Interface for the client that implements access methods to the Infrascale Service.

Namespace:  SOS.SDK
Assembly:  SOS.SDK (in SOS.SDK.dll) Version: 7.6.1.5742
Syntax
C#
public interface IInfrascaleClient : IInfrascaleSdk, 
	IInfrascaleSdkListener

The IInfrascaleClient type exposes the following members.

Properties
  NameDescription
Public propertyIsConnected
Infrascale Service is connected now.
Public propertyTracer
Tracer of the connection events.
Top
Methods
  NameDescription
Public methodCancelJob
Cancel running Job. Please note: use CancelOnlineBackup(CancelOnlineBackupRequest) method for cancelling OnlineBackup Job.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleCancelOnlineBackup
Cancel the current backup session.
(Inherited from IInfrascaleSdk.)
Public methodConnect
Estabilish connection to the Infrascale Service.
Public methodDisconnect
Disconnect from the Infrascale Service.
Public methodCode exampleGetAccountInfo
Returns information about signed in account.
(Inherited from IInfrascaleSdk.)
Public methodGetApplicationSettings
Get the Application settings.
(Inherited from IInfrascaleSdk.)
Public methodGetJobSession
Retrieves job's state by JobId.
(Inherited from IInfrascaleSdk.)
Public methodGetJobSessions
Retrieves states of all running Jobs.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleGetOnlineBackupSettings
Get Online Backup settings from the settings storage.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleGetRecoveryItems
Retrieves the list of folders and files available for recovery at specified Path. If Path is not specified returns a list of systems.
(Inherited from IInfrascaleSdk.)
Public methodIsMSExchangePresent
Check if MSExchange is present on this system.
(Inherited from IInfrascaleSdk.)
Public methodIsMSSqlPresent
Check if MSSql is present on this system.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleListen(ActionJobSessionContract, ActionJobSessionContract, ActionJobEventsContract, ActionJobSessionContract)
Create an instance of the JobSessionAggregatedListener for listen all Job callbacks without specifiyng callback types. Use other specified Jobs related listeners, if you know real type of the listened Job.
(Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenTStarted, TProgress, TEvents, TCompleted(ActionTStarted, ActionTProgress, ActionTEvents, ActionTCompleted)
Create an instance of the JobSessionAggregatedListenerBaseTStarted, TProgress, TEvents, TCompleted for listen all Job callbacks with specified callback types. Handles all callbacks. Use other specified Jobs related listeners, if you know real type of the listened Job.
(Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenJobCompletedT (Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenJobEventsT (Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenJobProgressT (Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenJobStartedT (Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenOnlineBackupJob
Create an instance of the OnlineBackupAggregatedListener for listen all OnlineBackup Job callbacks.
(Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenRecoveryJob
Create an instance of the RecoveryAggregatedListener for listen all Recovery Job callbacks.
(Inherited from IInfrascaleSdkListener.)
Public methodCode exampleListenRefreshRecoveryInfoJob
Create an instance of the RefreshRecoveryAggregatedListener for listen all RefreshRecovery Job callbacks.
(Inherited from IInfrascaleSdkListener.)
Public methodLoadBaremetalBackupSchedule
Load Baremetal Backup schedule.
(Inherited from IInfrascaleSdk.)
Public methodLoadExchangeBackupSchedule
Load Exchange Backup schedule.
(Inherited from IInfrascaleSdk.)
Public methodLoadImageStreamBackupSchedule
Load ImageStream Backup schedule.
(Inherited from IInfrascaleSdk.)
Public methodLoadMSSqlBackupSchedule
Load MSSql Backup schedule.
(Inherited from IInfrascaleSdk.)
Public methodLoadOnlineBackupSchedule
Load Online Backup schedule.
(Inherited from IInfrascaleSdk.)
Public methodCode examplePauseOnlineBackup
Pause the current backup session.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleRemoveOnlineBackupSettings
Remove existing Online Backup settings from the settings storage.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleResumeOnlineBackup
Resume the current backup session (if paused).
(Inherited from IInfrascaleSdk.)
Public methodRunLiveProtect
Run LiveProtect.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleRunOnlineBackupJob
Add new Online Backup job request using existing settings.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleRunRecoveryJob
Starts Recovery Job.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleRunRefreshRecoveryInfoJob
Starts RefreshRecoveryInfo job that refreshes local db of metadata by syncing it with backup server.
(Inherited from IInfrascaleSdk.)
Public methodScanNtfsVolume
Start Scan NTFS Volume Job.
(Inherited from IInfrascaleSdk.)
Public methodScheduleBaremetalBackup
Schedule Baremetal Backup Job.
(Inherited from IInfrascaleSdk.)
Public methodScheduleExchangeBackup
Schedule Exchange Backup Job.
(Inherited from IInfrascaleSdk.)
Public methodScheduleImageStreamBackup
Schedule ImageStream (Advanced) Backup Job.
(Inherited from IInfrascaleSdk.)
Public methodScheduleMSSqlBackup
Schedule MS SQL Backup Job.
(Inherited from IInfrascaleSdk.)
Public methodScheduleOnlineBackup
Schedule Online Backup Job.
(Inherited from IInfrascaleSdk.)
Public methodScheduleUpdateNotifier
Schedule UpdateNotifier launch.
(Inherited from IInfrascaleSdk.)
Public methodSetInternetSettings
Set Internet (Proxy) settings.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleSetOnlineBackupSettings
Add Online Backup settings to the settings storage.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleSignIn
Creates session for specific backup account using User Credentials.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleSignOut
Signing out backup account on Infrascale Service.
(Inherited from IInfrascaleSdk.)
Public methodStopLiveProtect
Stop LiveProtect.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleSubscribeCallback
Allows to receive notification about events are occurred in scope of specific backup account.
(Inherited from IInfrascaleSdk.)
Public methodUnscheduleBaremetalBackup
Delete schedules of the Baremetal Backup.
(Inherited from IInfrascaleSdk.)
Public methodUnscheduleExchangeBackup
Delete schedules of the Exchange Backup.
(Inherited from IInfrascaleSdk.)
Public methodUnscheduleImageStreamBackup
Delete schedules of the ImageStream Backup.
(Inherited from IInfrascaleSdk.)
Public methodUnscheduleMSSqlBackup
Delete schedules of the MSSql Backup.
(Inherited from IInfrascaleSdk.)
Public methodUnscheduleOnlineBackup
Delete schedules of the OnlineBackup.
(Inherited from IInfrascaleSdk.)
Public methodCode exampleUnsubscribeCallback
Stops receiving notification about events are occurred in scope of specific backup account.
(Inherited from IInfrascaleSdk.)
Public methodUpdateServerAuthToken
Operation for update ServerAuthToken for the Account.
(Inherited from IInfrascaleSdk.)
Top
Events
  NameDescription
Public eventJobCompleted
Occurs when Job is completed.
Public eventJobEvents
Occurs when Job reports about new events.
Public eventJobProgress
Occurs when new progress report is aquired.
Public eventJobStarted
Occurs when Job is started.
Public eventPipeConnectionEstablished
Occurs when connection to the Infrascale Service is estabilished.
Public eventPipeConnectionLost
Occurs when connection to the Infrascale Service is lost.
Public eventServerAuthTokenExpired
Occurs when Auth by ServerAuthToken used and indicates about expiration of current ServerAuthToken.
Top
See Also