ICISiteBackupInfo Interface

Use ICISiteBackupInfo interface to retrieve information about a Site that has been backed up.

interface ICISiteBackupInfo : IDispatch {

See also the ICIBackupArchiveInfo::GetSiteBackupInfo, ICIBackupArchiveInfo::SetSiteBackupInfo methods.

Members (Listed alphabetically)

  • Property AuthManagerDataBase As String

    • Retrieves or specifies the path to the authentication manager user database.

    HRESULT AuthManagerDataBase([out, retval] BSTR* pVal);
HRESULT AuthManagerDataBase([in] BSTR newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "Site auth manager database: " & oBackupSiteInfo.AuthManagerDataBase

    Specifying:

    oBackupSiteInfo.AuthManagerDataBase = "C:\Documents and Settings\All Users\Application Data\GlobalSCAPE\EFT Enterprise\MySite.aud"

    EFT v6.3 to 7.3.3.20

  • Property AuthManagerID As String

    • Retrieves or specifies the authentication manager ID.

    HRESULT AuthManagerID([out, retval] BSTR* pVal);
HRESULT AuthManagerID([in] BSTR newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "Site auth manager: " & oBackupSiteInfo.AuthManagerID

    Specifying:

    oBackupSiteInfo.AuthManagerID = "LOCAL"

    EFT v6.3 and later

  • Property DMZAddress As String

    • Retrieves or specifies the DMZ Gateway IP address.

    HRESULT DMZAddress([out,retval] BSTR* pVal);
HRESULT DMZAddress([in] BSTR newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "DMZ IP: " & oBackupSiteInfo.DMZAddress

    Specifying:

    oBackupSiteInfo.DMZAddress = "192.168.0.88"

    EFT v6.3 and later

  • Property DMZEnabled As Boolean

    • Retrieves or specifies whether the DMZ Gateway is enabled.

    HRESULT DMZEnabled([out,retval] VARIANT_BOOL* pVal);
HRESULT DMZEnabled([in] VARIANT_BOOL newVal);

    TRUE=Enabled; FALSE=Disabled

    Example (VBScript):

    Retrieving:

    MsgBox "DMZ enabled: " & CStr(oBackupSiteInfo.DMZEnabled)

    Specifying:

    oBackupSiteInfo.DMZEnabled = True

    EFT v6.3 and later

  • Property DMZPort As Long

    • Retrieves or specifies the DMZ Gateway port number.

    HRESULT DMZPort([out,retval] LONG* pVal);
    HRESULT DMZPort([in] LONG newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "DMZ port: " & oBackupSiteInfo.DMZPort

    Specifying:

    oBackupSiteInfo.DMZPort = 8888

    EFT v6.3 and later

  • Function GetGoogleDriveGeneralParams() As CICloudGoogleDriveGeneralParams and SetGoogleDriveGeneralParams() As CICloudGoogleDriveGeneralParams

    • HRESULT GetGoogleDriveGeneralParams([out, retval] ICICloudGoogleDriveGeneralParams** ppVal);
HRESULT SetGoogleDriveGeneralParams([in] ICICloudGoogleDriveGeneralParams* pVal);

    EFT v8.2

  • Function GetSiteRoot() As Object

    • Retrieve the Site root. (See also SetSiteRoot.)

    HRESULT GetSiteRoot([out, retval] IDispatch** ppdispSiteRoot);

    EFT v8.1 and later

  • Property ListenIP As String read-only

    • Retrieve the listener IP of the backed-up Site.

    HRESULT ListenIP([out, retval] BSTR* pVal);

    Example (VBScript):

    Retrieving:

    MsgBox "Old listen IP is: " & oBackupSiteInfo.ListenIP

    EFT v6.3 and later

  • Property ListenIPs As Variant

    • Retrieves or specifies the IP addresses on which the server listens.

    HRESULT ListenIPs([out, retval] VARIANT* pVal);
HRESULT ListenIPs([in] VARIANT newVal);

    EFT v6.4 and later

  • Property NewListenIP As Variant

    • Retrieves or specifies the new listen IP address.

    HRESULT NewListenIP([out, retval] BSTR* pVal);
HRESULT NewListenIP([in] BSTR newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "New listen IP is: " & oBackupSiteInfo.NewListenIP

    Specifying:

    NewListenIP = "127.0.0.1"

    EFT v6.3 and later

  • Property NewListenIPs As String

    • Retrieves or specifies multiple new listen IP addresses.

    HRESULT NewListenIPs([out, retval] VARIANT* pVal);
HRESULT NewListenIPs([in] VARIANT newVal);

    EFT v6.4 and later

  • Property RestoreSite As Boolean

    • Retrieves or specifies whether you need to restore the Site.

    HRESULT RestoreSite([out, retval] VARIANT_BOOL* pVal);
HRESULT RestoreSite([in] VARIANT_BOOL newVal);

    TRUE=Enabled; FALSE=Disabled

    Example (VBScript):

    Retrieving:

    bRestore = oBackupSiteInfo.RestoreSite

    Specifying:

    oBackupSiteInfo.RestoreSite = True

    EFT v6.3 and later

  • Property RestoreVFS As Boolean

    • Retrieves or specifies whether to restore the VFS permissions and folders.

    HRESULT RestoreVFS([out, retval] VARIANT_BOOL* pVal);
HRESULT RestoreVFS([in] VARIANT_BOOL newVal);

    TRUE=Enabled; FALSE=Disabled

    Example (VBScript):

    Retrieving:

    bRestore = oBackupSiteInfo.RestoreVFS

    Specifying:

    oBackupSiteInfo.RestoreVFS = True

    EFT v6.3 and later

  • Property RootFolder As String

    • Retrieves or specifies the path to the root folder.

    HRESULT RootFolder([out, retval] BSTR* pVal);
HRESULT RootFolder([in] BSTR newVal);

    Example (VBScript):

    Retrieving:

    MsgBox "Site root folder is: " & oBackupSiteInfo.RootFolder

    Specifying:

    oBackupSiteInfo.RootFolder = "F:\ "

    EFT v6.3 and later

  • Sub SetSiteRoot(pdispSiteRoot As Object)

    • Specify the Site root. (See also GetSiteRoot.)

    HRESULT SetSiteRoot([in] IDispatch* pdispSiteRoot);

    EFT v8.1 and later

  • Property SiteName As String read-only

    • Retrieve the Site name.

    HRESULT SiteName([out, retval] BSTR* pVal);

    Example (VBScript):

    Retrieving:

    MsgBox "Site name is: " & oBackupSiteInfo.SiteName

    EFT v6.3 and later