Enable-AzStackHCIRemoteSupport

  • Reference
Module:
Az.StackHCI

Enables Remote Support.

Syntax

Enable-AzStackHCIRemoteSupport
      [-AccessLevel] <String>
      [[-ExpireInMinutes] <Int32>]
      [[-SasCredential] <String>]
      [-AgreeToRemoteSupportConsent]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Enables Remote Support allows authorized Microsoft Support users to remotely access the device for diagnostics or repair depending on the access level granted.

Examples

Example 1:

Enable-AzStackHCIRemoteSupport -AccessLevel Diagnostics -ExpireInMinutes 1440 -SasCredential "Sample SAS"

Proceed with enabling remote support?
[Y] Yes  [N] No: Y

Enabling Remote Support for 'Diagnostics' expiring in '1440' minutes.
Using provided SAS credential to make remote support connection.
Remote Support successfully Enabled.


State         : Active
CreatedAt     : 3/29/2022 10:29:19 AM +00:00
UpdatedAt     : 3/29/2022 10:29:19 AM +00:00
TargetService : PowerShell
AccessLevel   : Diagnostics
ExpiresAt     : 3/30/2022 10:29:18 AM +00:00
SasCredential :

Enable Remote Support on machine

Example 2:

Enable-AzStackHCIRemoteSupport -AccessLevel DiagnosticsRepair -ExpireInMinutes 1440 -SasCredential "Sample SAS" -AgreeToRemoteSupportConsent

Enabling Remote Support for 'Diagnostics' expiring in '1440' minutes.
Using provided SAS credential to make remote support connection.
Remote Support successfully Enabled.


State         : Active
CreatedAt     : 3/29/2022 10:29:19 AM +00:00
UpdatedAt     : 3/29/2022 10:29:53 AM +00:00
TargetService : PowerShell
AccessLevel   : Diagnostics
ExpiresAt     : 3/30/2022 10:29:53 AM +00:00
SasCredential :

Enable remort support by providing consent. In this case, user is not prompted for consent

Parameters

-AccessLevel

Controls the remote operations that can be performed. This can be either Diagnostics or DiagnosticsAndRepair.

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

-AgreeToRemoteSupportConsent

Optional. If set to true then records user consent as provided and proceeds without prompt.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-ExpireInMinutes

Type:Int32
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SasCredential

Hybrid Connection SAS Credential.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Outputs

Boolean