vRanger 7.7 - User Guide

vAPI Cmdlet details

 

IMPORTANT: For the most up-to-date help contents, see the cmdlet help. To get help on any of the vAPI cmdlets, use the Get-Help command. At the prompt, enter: Get-Help <command> ‑full where <command> is any of the following vAPI cmdlets.

Add-BackupGroupEntity

 

Description	Adds a new backup group to vRanger. New-BackupGroupMember cmdlet is used to add members to a backup group created using this cmdlet or the UI.
Syntax	Add-BackupGroupEntity [‑BackupGroupName] <String> [<CommonParameters>]
Parameters	• BackupGroupName <String>: The BackupGroup Name. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters" • Type [-Type]: This optional parameter specifies the type of backup group: VMware, HyperV, or Physical. If not specified, the default is VMware.
Examples	Add-BackupGroupEntity ‑BackupGroupName BG1
Related links	Remove-BackupGroupEntity New-BackupGroupMember Remove-BackupGroupMember Get-BackupGroupEntity

Add-BackupJobTemplate

Add-BackupJobTemplate

 

Description	Adds a backup job. You also have the option of running the job immediately after the template is created.
Syntax	Add-BackupJobTemplate [‑JobName] <String> [[‑JobDescription] <String>] [‑JobEntity] <Entity> [[‑ExcludedVMList] <String>] [[‑IncludedDiskList] <String>] [‑TargetRepository] <Repository> [[‑JobSchedule] <Schedule>] [‑Flags] <NoFlags | BackupPoweredOnOnly | CheckDestinationFreeSpace | UseCompression | UpdateNotes | EnableGuestQuiescing | EnableABM | UseFiber | PerformNetworkBackupOnFailure | UseCataloging | AllFlags> [‑NumberOfSavePoints] <Int> [‑SpaceSavingTechnologyTypeFlag] <None | Incremental | Differential> [[‑SpaceSavingCountThreshold] <Int>] [[‑SpaceSavingPercentSizeThreshold] <Int>] [[‑NotificationList] <String>] [[‑RunJobNow] <Boolean>] [[‑TransportConfiguration] <TransportConfiguration>] [[‑FullBackupDays] <List`1>][<CommonParameters>]
Parameters	• JobName <String>: Job name. • JobDescription [<String>]: Job description. • JobEntity <Entity>: Inventory entity on which the job is going to run on — VMware® ESXi™ host, VirtualCenter, and so on. • ExcludedVMList [<String>]: List of VM universally unique identifiers (UUIDs) to exclude from this job. • IncludedDiskList [<String>]: List of virtual disks to include in this job. • TargetRepository <Repository>: Repository where the backups are to be stored. • JobSchedule [<Schedule>]: Schedule on which the job runs. • Flags <BackupFlags>: Backup flags. • NumberOfSavePoints <Int>: Max number of savepoints to store before older ones are removed. • SpaceSavingTechnologyTypeFlag <SpaceSavingTechnologyType>: Spacesaving technology to use: differential, incremental or none. • SpaceSavingCountThreshold [<Int>]: The number to save before performing a full backup. • SpaceSavingPercentSizeThreshold [<Int>]: The size to allow as a % of the VM hard disk file before performing a differential backup. • NotificationList [<String>]: Email notification list for the job. • RunJobNow [<Boolean>]: Whether to run the job now. • TransportConfiguration [<TransportConfiguration>]: The transport configuration options to use for this job. • FullBackupDays [<List '1>]: The days to perform a full backup. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-BackupJobTemplate ‑JobName myjob ‑JobEntity $inv ‑TargetRepository $repo ‑JobSchedule $s ‑Flags NoFlags ‑NumberOfSavePoints 3 ‑SpaceSavingTechnologyTypeFlag None This command adds a backup job template. Because the RunJobNow flag is not specified, the job does not run immediately.
Related links	Add-RestoreJobTemplate Add-PhysicalMachine Update-BackupJobTemplate Get-Job Get-JobTemplate

Add-CIFSRepository

Add-CIFSRepository

 

Description	Adds a CIFS repository to vRanger. The repository can be later used to store backup files from backup jobs.
Syntax	Add-CifsRepository [‑Server] <String> [‑ShareName] <String> [[‑TargetDirectory] <String>] [‑DomainName] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>] [[‑Overwrite] <Boolean>] [[‑EnableEncryption] <Boolean>] [[‑EncryptionPassword] <String>] [[‑ImportOption] <String>] [<CommonParameters>]
Parameters	• Server <String>: The CIFS Server FQDN or IP. • ShareName <String>: Name of the file-system share the repository is on. • TargetDirectory [<String>]: The CIFS target directory. • DomainName <String>: Name of the domain. • User <String>: The CIFS user name. • Password <String>: The CIFS password. • Name <String>: A friendly name describing this CIFS server. • Description [<String>]: The description of the CIFS server. • Overwrite [<Boolean>]: Whether to overwrite the existing repository if one exists. • EnableEncryption [<Boolean>]: Whether to enable encryption. • EncryptionPassword [<String>]: The encryption Password. • ImportOption [<String>]: Whether to import the save points as read-write or read-only. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-CifsRepository ‑Server myserver.dev.corp ‑Sharename myshare ‑TargetDirectory myrepo ‑User myname ‑Password mypassword ‑Name myCifs Repo ‑Overwrite 1 This command adds a repository on server myserver.dev.corp pointing to a share named myshare using the credentials provided. Existing repositories at the location specified are overwritten.
Related links	Get-PhysicalMachineDiskMap Add-DdbRepository Add-HypervCluster Add-NVSDRepository

Add-DdbReplicationRepository

Add-DdbReplicationRepository

 

Description	Adds an EMC® Data Domain® Boost (DD Boost™) replication repository to vRanger.
Syntax	Add-DdbReplicationRepository [‑Server] <String> [StorageUnit] <String> [‑User] <String> [‑Password] <String> [‑Name] <String> [[‑Description] <String>][‑RepositoryId] <String> [<CommonParameters>]
Parameters	• Server <String>: The DD Boost server FQDN or IP. • StorageUnit <String>: The DD Boost storage unit. • User <String>: The user name to access the DD Boost server. • Password <String>: The password to access the DD Boost server. • Name <String>: A friendly name describing this DD Boost server. • Description [<String>]: The description of the DD Boost server. • RepositoryId <String>: Repository ID in GUID. • <CommonParameters>: This cmdlet supports the common parameters: ‑Verbose, ‑Debug, ‑ErrorAction, ‑ErrorVariable, ‑WarningAction, ‑WarningVariable, ‑OutBuffer, and ‑OutVariable. For more information, type: "get-help about_commonparameters"
Examples	Add-DdbReplicationRepository ‑Server myserver.dev.corp ‑StorageUnit mystorage ‑User myname ‑Password mypassword ‑Name myDDB Repo ‑RepositoryId 82E8A98A-1165-4ABE-966B-0E0AEF260620 This command configures a replication repository for repository identified by ID 82E8A98A-1165-4ABE-966B-0E0AEF260620 on server myserver.dev.corp pointing to a storage unit named mystorage using the credentials provided.
Related links	Get-Repository Add-DdbRepository