XenApp and XenDesktop 7.6

New-AdminScope

Sep 10, 2014

Adds a new scope to the site.

Syntax

New-AdminScope [-Name] <String> [-Description <String>] [-LoggingId <Guid>] [-AdminAddress

<String>] [<CommonParameters>]

Detailed Description

New-AdminScope adds a new scope object to the site.

A scope represents a collection of objects. Scopes are used to group objects in a way that is relevant to the organization; for example, the set of delivery groups used by the Sales team.

You can create objects in particular scopes by specifying the -Scope parameter of a New- cmdlet for an object that can be scoped. You can then modify the contents of a scope with Add-<Noun>Scope and Remove-<Noun>Scope cmdlets from the correpsonding PowerShell snap-ins.

To assign a scope to an administrator, combine it with a role and then assign this pair (also known as a 'right') to an administrator. See Add-AdminRight for further details.

The identifier of the new scope is chosen automatically.

Related topics

Get-AdminScope

Set-AdminScope

Rename-AdminScope

Remove-AdminScope

Set-AdminScopeMetadata

Remove-AdminScopeMetadata

Add-AdminRight

Parameters

-Name<String>

Specifies the name of the scope. Each scope in a site must have a unique name.

Required?

true

Default Value https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.2257

Accept Pipeline Input?

-Description<String>

Specifies the description of the scope.

Required?

Default Value

Accept Pipeline Input?

true (ByPropertyName) false true (ByPropertyName)

-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

Accept Pipeline Input?

Localhost. Once a value is provided by any cmdlet, this value becomes the default.

false

Input Type

None You cannot pipe input into this cmdlet.

Return Values

Citrix.DelegatedAdmin.Sdk.Scope

https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.2258

The newly created scope.

Examples

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

C:\PS> New-AdminScope -Name Sales -Description "Sales department scope"

C:\PS> Add-HypHypervisorConnectionScope -HypervisorConnectionName XenServer2 -Scope Sales

C:\PS> Add-AdminRight -Administrator DOMAIN\TestUser -Role Hosting -Scope Sales

Creates a new scope called 'Sales', adds a hypervisor connection object to the scope, and then assigns the right to use the hosting role on the Sales scope to the 'TestUser' administrator.

https://docs.citrix.com

© 1999-2017 Citrix Systems, Inc. All rights reserved.

p.2259