Developer Documentation
Citrix Daas SDK

New-AdminScope

August 9, 2024
Contributed by: 
C C

Adds a new scope to the site.

Syntax

New-AdminScope
   [-Description <String>]
   [-Name] <String>
   [-TenantId <String>]
   [-TenantName <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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.

New-AdminScope -Name Sales -Description "Sales department scope"
Add-HypHypervisorConnectionScope -HypervisorConnectionName XenServer2 -Scope Sales
Add-AdminRight -Administrator DOMAIN\TestUser -Role Hosting -Scope Sales
<!--NeedCopy-->

Parameters

-Name

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

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

-Description

Specifies the description of the scope.

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

-TenantId

Specifies the tenant customer identifier of the scope.

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

-TenantName

Specifies the new tenant name.

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

-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.Scope

The newly created scope.

New-AdminScope
August 9, 2024
Contributed by: 
C C
August 9, 2024
Contributed by: 
C C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.