Citrix Virtual Apps and Desktops SDK

Update-AcctADAccount

Updates the state of Active Directory (AD) accounts.

Syntax

Update-AcctADAccount
      [-IdentityPoolName] <String>
      [-AllAccounts]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Update-AcctADAccount
      -IdentityPoolUid <Guid>
      [-AllAccounts]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to synchronize the state of the Active Directory (AD) accounts stored in the AD Identity Service with the AD accounts themselves. By default, this checks all accounts marked as ‘error’ to determine if accounts are still in an error state (i.e. disabled or locked). If you specify the ‘AllAccounts’ option, it checks all accounts regardless of error state and updates their status.

Examples

EXAMPLE 1

Checks the status of accounts in the identity pool MyPool that are currently in the Error state, marking them as Available, InUse, Tainted or Error as appropriate.

Update-AcctADAccount -IdentityPoolName MyPool
<!--NeedCopy-->

EXAMPLE 2

Checks the status of all accounts in the identity pool MyPool marking them as Available, InUse, Tainted or Error as appropriate.

Update-AcctADAccount -IdentityPoolName MyPool -AllAccounts
<!--NeedCopy-->

Parameters

-IdentityPoolName

The name of the identity pool of the AD accounts that are to be updated.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IdentityPoolUid

The unique identifier for the identity pool of the AD accounts that are to be updated.

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

-AllAccounts

Indicates if all accounts should be updated or only the ones marked as in error.

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Notes

In the case of failure, the following errors can result.

Error Codes


PermissionDenied

The user does not have administrative rights to perform this operation.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error

DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

ServiceStatusInvalidDb

An error occurred in the service while attempting a database operation - communication with database failed for various reasons.

CommunicationError

An error occurred while communicating with the service.

ExceptionThrown

An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the Citrix Virtual Apps and Desktops logs.

Update-AcctADAccount