Methods and Properties of BackupSet.Destination Interface

• Type - property, the destination type for a backup copy (FTP, SFTP, LAN).

  Syntax:

  Object.Destination.Type

  {property[in, out] BSTR}

  Recieves and returns the following values:
  1. "FTP"
  2. "FTPS-EXPLICIT"
  3. "FTPS-IMPLICIT"
  4. "SFTP"
  5. "LAN"
  6. "S3 AMAZON"
  
  

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.Type = "SFTP" 'destination is SFTP server
• Path - property, the path to backup copy on the server.

  Syntax:

  Object.Destination.Path

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.Path = "/" 'specify the path on the server
• UserName - property, user login on the server.

  Syntax:

  Object.Destination.UserName

  {property[in, out] BSTR}

• Password - user password on the server.

  Syntax:

  Object.Destination.Password

  {property[in] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.UserName = "ExampleUser" ' user login – ExampleUser
  MySet.Destination.Password = "ExamplePassword" 'user password – ExamplePassword
• Host - property, server address or computer name within the local network.

  Syntax:

  Object.Destination.Host

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.Host = "somehost.com" 'server address is “somehost.com”
• Port - property, server port.

  Syntax:

  Object.Destination.Port

  {property[in, out] LONG}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.Port = 21 'use the port 21
• SFTPAuthType - property, authentication type of SFTP server.

  Syntax:

  Object.Destination.SFTPAuthType

  {property[in, out] BSTR}

  Recieves and returns the following values:
  1. "PASSWORD"
  2. "PUBKEY"
  3. "BOTH"
  
  

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.SFTPAuthType = "PASSWORD" 'SFTP authentication by passwrd only
• PublicKeyPath - property, full path to a file with a public key (use in the cases of the key authentication or the key/password authentication).

  Syntax:

  Object.Destination.PublicKeyPath

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.PublicKeyPath = "d:\ExampleKey.pub" 'path to a file with a public key
• PrivateKeyPath - property, full path to a file with a private key (use in the cases of the key authentication or the key/password authentication).

  Syntax:

  Object.Destination.PrivateKeyPath

  {property[in, out] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.PrivateKeyPath = "d:\ExampleKey.priv" 'path to a file with a private key
• PrivateKeyPassphrase - property, passphrase to private key (use in the cases of the key authentication or the key/password authentication).

  Syntax:

  Object.Destination.PrivateKeyPassphrase

  {property[in] BSTR}

  Example:
  

  Set MyBackupApp = CreateObject("LeoBackup.Application")
  Set MySet = MyBackupApp.OpenBackupSet("MyBackupSet") 'open the backup set
  MySet.Destination.PrivateKeyPassphrase = "password" 'password to private key