Get-BrokerStorefrontAddress
Gets the high-level description of a configuration for StoreFront addresses, based on a configuration byte array.
Syntax
Get-BrokerStorefrontAddress
[-ByteArray] <Byte[]>
[<CommonParameters>]
Description
Use this command to convert a configuration byte array into a set of named property settings. The byte array will either have been retrieved from the Citrix Broker Service, or from the New-BrokerStorefrontAddress cmdlet.
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.
Parameters
-ByteArray
Specifies the low-level byte array (blob) to be interpreted.
| Type: | Byte[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| 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
\[\]
The cmdlet accepts the ByteArray parameter as pipeline input.
Outputs
Citrix.Storefront.Sdk.BrokerStorefrontAddress
This cmdlet outputs one BrokerStorefrontAddress object for each address that is configured within the slot. Each object has the following properties:
Name - Specifies the name of the StoreFront.
Url - Specifies the URL to the StoreFront, such as "
<https://mysite.com/Citrix/StoreWeb>".
Enabled - Specifies whether the StoreFront is enabled for users.
Description - Specifies the human-readable name of the StoreFront.