Appliance Category | Vmware PowerCLI Reference

Appliance Category

Cmdlets are usually implemented around resource operations. The four basic operations are CREATE, READ, UPDATE and DELETE. This set of operations is known as CRUD. Most of the cmdlets support CRUD which are respectively cmdlets that start with the New/Get/Set/Remove cmdlet verbs but they also may have additional operations

Step 1: Retrieve a object by running a Get command

You can READ objects by using Get-ApplianceBackupJob cmdlet. See example below: 
# List all backup jobs.
Get-ApplianceBackupJob

Step 2 : Run commands from the CRUD group

You can CREATE objects by using New-ApplianceBackupJob cmdlet. See example below: 
# Starts a backup job for a vCenter Server system that is going to be stored at an FTP server in the /backups/manual_backup_1 folder and encrypted with a password. Only mandatory backup parts are included since no optional backup parts have been specified.
PS C:\> New-ApplianceBackupJob `
   -BackupServerType FTP `
   -BackupServer <backup server ip> `
   -BackupServerPort 21 `
   -BackupServerUsername <backup server username> `
   -BackupServerPassword <backup server password> `
   -FolderPath /backups/manual_backup_1 `
   -Description "This is a custom comment"
You can UPDATE objects by using Stop-ApplianceBackupJob cmdlet. See example below: 
# Stops all backup jobs on the specified vCenter Server.
PS C:\> Get-ApplianceBackupJob -Server 'vCenter Server' | Stop-ApplianceBackupJob

Step 3: Explore More Related Commands:


Get-ApplianceBackupPart This cmdlet retrieves backup parts that can be included in a backup for a vCenter Server system.
Wait-ApplianceBackupJob This cmdlet monitors the progress of a backup job and returns the ApplianceBackupJob object when the backup job is complete.