# Backup-CVSQLInstance

The `Backup-CVSQLInstance` cmdlet submits a backup job for a SQL server instance.

Before you can use this cmdlet, you must log on to your CommCell environment using the `Connect-CVServer` cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.

## Syntax

    Backup-CVSQLInstance -Name $[String] [-BackupType $[full | incremental | differential]] [-Force] [-WhatIf] [-Confirm] [$[CommonParameters]]

    Backup-CVSQLInstance -InstanceObject $[Object] [-BackupType $[full | incremental | differential]] [-Force] [-WhatIf] [-Confirm] [$[CommonParameters]]

## Required Parameters

Parameter | Description | Data type | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | ---
`–Name` | The name of the instance. | String | No | No | Named
`–InstanceObject` | The object that represents the instance. | Object | Yes, by: Value Property name | No | Named

## Optional Parameters

### Commvault Parameters

Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter
--- | --- | --- | --- | --- | --- | ---
`–BackupType` | The type of backup to perform. | String | Valid values: Full Incremental (default) Differential | No | No | Named

### Microsoft PowerShell Parameters

You can use the following Microsoft PowerShell parameters:

- Debug

- ErrorAction

- ErrorVariable

- OutBuffer

- OutVariable

- PipelineVariable

- Verbose

- WarningAction

- WarningVariable

- Force

- Confirm

- WhatIf

Note

Only a few cmdlets support Force, Confirm, and WhatIf parameters.

For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.

## Input

This cmdlet does not support input.

## Output

A PSCustomObject that indicates whether the job completed successfully.

×

Loading...