Edit

Share via

Get-NetworkControllerBackup

  • Reference
Module:
NetworkController

Gets the status of a backup operation.

Syntax

Get-NetworkControllerBackup
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

The Get-NetworkControllerBackup cmdlet gets the status of a backup operation started with the New-NetworkControllerBackup cmdlet

Examples

Example 1: Get all Network Controller backups

Get-NetworkControllerBackup -ConnectionUri https://networkcontroller

This command gets the status of backups for the specified Network Controller.

Example 2: Get a network controller backup

$Credential = Get-Credential
Get-NetworkControllerBackup -ResourceId "BackupUser" -ConnectionUri https://networkcontroller -Credential $Credential

This command gets the Network Controller backup for the specified ID.

Parameters

-CertificateThumbprint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of a Network Controller. The cmdlet gets backups for that controller.

Type:Uri
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies a user credential that has permission to perform this action. The default value is the current user.

This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassInnerException

This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

Specifies the resource ID of the backup to get.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Object