Product Documentation

Set-AdminAdministrator

Oct 12, 2015

Sets the properties of an administrator.

Syntax

Set-AdminAdministrator [-InputObject] <Administrator[]> [-Enabled <Boolean>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-AdminAdministrator -Sid <String[]> [-Enabled <Boolean>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Set-AdminAdministrator [-Name] <String[]> [-Enabled <Boolean>] [-PassThru] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Set-AdminAdministrator cmdlet is used to enable or disable an existing administrator.

You can specify the administrators to modify in a number of ways, by piping in existing objects, by passing existing objects with the InputObject parameter, or by specifying the names or SIDs explicitly.

Parameters

-InputObject<Administrator[]>

Specifies the administrators to modify.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-Name<String[]>

Specifies the names of the administrators to modify.

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Sid<String[]>

Specifies the SIDs of the administrators to modify.

Required? true
Default Value  
Accept Pipeline Input? true (ByPropertyName)

-Enabled<Boolean>

Specifies the new value for the Enabled property.

Required? false
Default Value  
Accept Pipeline Input? false

-PassThru<SwitchParameter>

Returns the affected record. By default, this cmdlet does not generate any output.

Required? false
Default Value False
Accept Pipeline Input? false

-LoggingId<Guid>

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.

Required? false
Default Value  
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Input Type

Citrix.DelegatedAdmin.Sdk.Administrator You can pipe the adminstrators to be modified into this command.

Return Values

None or Citrix.DelegatedAdmin.Sdk.Administrator

When you use the PassThru parameter, Set-AdminAdministrator generates a Citrix.DelegatedAdmin.Sdk.Administrator object. Otherwise, this cmdlet does not generate any output.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Get-AdminAdministrator -Enabled $false | Set-AdminAdministrator -Enabled $true

Enable all administrators that are currently disabled.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> Set-AdminAdministrator -Name DOMAIN\TestUser1,DOMAIN\TestUser2 -Enabled $true

Enable two specific users specified by name (TestUser1 and TestUser2).