Citrix Virtual Apps and Desktops SDK

New-AdminAdministrator

Adds a new administrator to the site.

Syntax

New-AdminAdministrator
   [-Enabled <Boolean>]
   [-IsHidden <Boolean>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-AdminAdministrator
   [-Enabled <Boolean>]
   [-IsHidden <Boolean>]
   [-Name] <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-AdminAdministrator
   [-Enabled <Boolean>]
   [-IsHidden <Boolean>]
   -Sid <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

New-AdminAdministrator creates a new administrator object in the site. Once a new administrator has been created you can assign rights (role and scope pairs) to the administrator.

Administrator objects are used to determine what rights, and therefore what permissions a particular Active Directory user has through the various SDKs and consoles of the site.

When the Enabled flag of an administrator is set to false, any rights of the administrator are ignored by the system when performing permission checks.

This cmdlet cannot be used in case of DaaS customers.

Examples

EXAMPLE 1

Creates a new administrator object for user “DOMAIN\TestUser”. It defaults to enabled.

New-AdminAdministrator -Name DOMAIN\TestUser
<!--NeedCopy-->

EXAMPLE 2

Creates a new administrator object for user with SID “S-1-2-34-1234567890-1234567890-1234567890-123”. It defaults to enabled.

New-AdminAdministrator -Sid S-1-2-34-1234567890-1234567890-1234567890-123
<!--NeedCopy-->

Parameters

-Sid

Specifies the SID (security identifier) of the user in Active Directory that this administrator corresponds to.

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

-Name

Specifies the user or group name in Active Directory that this administrator corresponds to.

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

-Enabled

Specifies whether the new administrator starts off enabled or not.

Type: Boolean
Position: Named
Default value: True
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsHidden

Specifies whether the administrator is hidden or not.

Type: Boolean
Position: Named
Default value: False
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2303

-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 cannot pipe input into this cmdlet.

Outputs

Citrix.DelegatedAdmin.Sdk.Administrator

The newly created administrator.

New-AdminAdministrator