Remove-SCOMRunAsProfile

Remove-SCOMRunAsProfile

Removes a Run As profile from a management group.

Syntax

Parameter Set: FromRunAsProfile
Remove-SCOMRunAsProfile [-RunAsProfile] <ManagementPackSecureReference[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-SCOMRunAsProfile cmdlet removes a Run As profile from a management group. A Run As profile is a group of associated Run As accounts that manage credentials and their distribution to different computers.

Parameters

-ComputerName<String[]>

Specifies an array that contains the name of the computer with which to establish a connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name (FQDN). To specify the local computer, specify the computer name, localhost, or a dot (.).

You must run the System Center Data Access service before you use this cmdlet.

If you do not specify this parameter, the default value is the computer for the current management group connection.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies the user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter. For more information about credential objects, type Get-Help Get-Credential.

This account must have access to the server that is specified in the ComputerName parameter if that parameter appears.

If you do not specify this parameter, the default value is the account for the current user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-RunAsProfile<ManagementPackSecureReference[]>

Specifies an array that contains the Run As profile that this cmdlet removes.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-SCSession<Connection[]>

Specifies an array of Connection objects. To get Connection objects, specify the Get-SCOMManagementGroupConnection cmdlet.

If this parameter does not appear, the cmdlet uses the active persistent connection to a management group. Use the SCSession parameter to specify a different persistent connection. You can create a temporary connection to a management group by using the ComputerName and Credential parameters. For more information, type Get-Help about_OpsMgr_Connections.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Remove a Run As profile

This command removes the Profile01 profile. The command uses the Get-SCOMRunAsProfile cmdlet to get the specified profile and pipes it to the Remove-SCOMRunAsProfile cmdlet.

PS C:\> Get-SCOMRunAsProfile "Profile01" | Remove-SCOMRunAsProfile

Add-SCOMRunAsProfile

Get-SCOMManagementGroupConnection

Get-SCOMRunAsProfile

Set-SCOMRunAsProfile

Get-Credential