Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

New-BrokerStorefrontAddress

April 19, 2024
Contributed by: 
C

Creates a new StoreFront address configuration, specifying a single address.

Syntax

New-BrokerStorefrontAddress
   -Name <String>
   -Url <String>
   -Enabled <Boolean>
   -Description <String>
   [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command when you want to create a new StoreFront configuration byte array from scratch, rather than modifying an existing one. You must define the URL for the StoreFront, and some additional details.

This command does not, by itself, have any persistent effects within XenDesktop. To make the change persistent, the new configuration byte array must first be transformed into a machine configuration within the Citrix Broker Service. To do this, use the New-BrokerMachineConfiguration command. You can then use the Add-BrokerMachineConfiguration and Set-BrokerMachineConfiguration commands to fully associate the new configuration with a delivery group.

Examples

EXAMPLE 1

This example shows a new configuration byte array being created to specify a single StoreFront address. The configuration byte array is then provided as input to the Get-BrokerStorefrontAddress command, which interprets and outputs the same fields.

$configuration = New-BrokerStorefrontAddress -Url "https://mysite.com/Citrix/StoreWeb" -Description "This StoreFront delivers my corporate applications" -Name "StoreFront1" -Enabled $true

Get-BrokerStorefrontAddress -ByteArray $configuration

Name               Url                                       Enabled Description
----               ---                                       ------- -----------
StoreFront1        https://mysite.com/Citrix/StoreWeb           True This StoreFront delivers my corporate applications.
<!--NeedCopy-->

Parameters

-Name

Specifies the name of the new StoreFront.

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

-Url

Specifies the URL to the StoreFront, such as “https://mysite.com/Citrix/StoreWeb”.

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

-Enabled

Specifies if the new StoreFront address should be enabled for user access.

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

-Description

Specifies a human-readable description of the new StoreFront.

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

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

Byte[]

The new configuration set, with all of the given modifications applied.

New-BrokerStorefrontAddress
April 19, 2024
Contributed by: 
C
April 19, 2024
Contributed by: 
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.