Citrix StoreFront SDK PowerShell Modules

Read-STFNetScalerConfiguration

March 5, 2024

Contributed by:

Read a NetScaler remote access configuration

Syntax

Read-STFNetScalerConfiguration [-Path] <String> [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Reads a NetScaler remote access configuration package into a NetScalerConfigurationDocument object to be imported into StoreFront.

Test-STFSecureTicketAuthority

Parameters

Name	Description	Required?	Pipeline Input	Default Value
Path	The NetScaler configuration file path.	true	true (ByValue)

Input Type

System.String

Parameter Path: The .NET System.String reference type

Return Values

NetScalerConfigurationDocument

The .NET Citrix.StoreFront.Model.Roaming.NetScalerConfiguration.NetScalerConfigurationDocument reference type

Notes

Configuration files are exported from NetScaler Gateway in .zip file format.

Examples

EXAMPLE 1 Read configuration package

$netscalerConfiguration = Read-STFNetScalerConfiguration –Path C:\NSG\Configuration.zip
<!--NeedCopy-->

REMARKS

The populated object can be supplied to the related cmdlets for validation and import.

OUTPUT

Certificate : [Subject]
CN=Example Certificate

[Issuer]
  CN=Example NetScaler certificate

[Serial Number]
  26E230B95A8FC3BA49E5A59C8026473E

[Not Before]
  27/02/2013 09:41:26

[Not After]
  31/12/2039 23:59:59

[Thumbprint]
  96FA87705E10654AAF0A7E88BB46A7D77DC154CA

Version     : 1.0
Time        : 2016-01-25T15:37:22.34
Document    : Citrix.StoreFront.Model.Roaming.NetScalerConfiguration.Document
<!--NeedCopy-->

EXAMPLE 2 Read configuration package with verbose messaging

Read-STFNetScalerConfiguration –Path C:\NSG\Configuration.zip -Verbose
<!--NeedCopy-->

REMARKS

The populated object can be supplied to the related cmdlets for validation and import. Messages related to the import are output to the console

OUTPUT

Certificate : [Subject]
CN=Example Certificate

[Issuer]
  CN=Example NetScaler certificate

[Serial Number]
  26E230B95A8FC3BA49E5A59C8026473E

[Not Before]
  27/02/2013 09:41:26

[Not After]
  31/12/2039 23:59:59

[Thumbprint]
  96FA87705E10654AAF0A7E88BB46A7D77DC154CA

Version     : 1.0
Time        : 2016-01-25T15:37:22.34
Document    : Citrix.StoreFront.Model.Roaming.NetScalerConfiguration.Document

VERBOSE: The gateway id us.gateway.citrix.com:443 has no Secure Ticket Authorities defined so can only be used for
authentication.
VERBOSE: The gateway id uk.gateway.citrix.com:443 has no Secure Ticket Authorities defined so can only be used for
authentication.
<!--NeedCopy-->

EXAMPLE 3 Read configuration package

$ImportedGateways = Read-STFNetScalerConfiguration -path "$env:USERPROFILE\desktop\GatewayConfig.zip" 
                           $ImportedGateways.Document.Gateways
<!--NeedCopy-->

REMARKS

The populated object can be inspected as shown to list all the gateway definitions. Messages related to the import are output to the console

OUTPUT

GatewayMode            : CVPN
                          CallbackUrl            :
                          GslbAddressUri         : https://gateway.domain.com/
                          AddressUri             : https://ukgateway.domain.com/
                          Address                : https://ukgateway.domain.com:443
                          GslbAddress            : https://gateway.domain.com.com:443
                          VipAddress             : 10.0.0.1
                          Stas                   : {STA298854503, STA909374257, STA443006025, STA490101972...}
                          StaLoadBalance         : True
                          CertificateThumbprints : {F549AFAA29EBF61E8709F2316B3981AD503AF387}
                          GatewayAuthType        : Domain
                          GatewayEdition         : Enterprise
                          ReceiverForWebSites    : {Citrix.StoreFront.Model.Roaming.NetScalerConfiguration.ReceiverForWebSite}

                          GatewayMode            : CVPN
                          CallbackUrl            :
                          GslbAddressUri         : https://gateway.domain.com/
                          AddressUri             : https://ukgateway.domain.com/
                          Address                : https://ukgateway.domain.com:443
                          GslbAddress            : https://gateway.domain.com.com:443
                          VipAddress             : 10.0.0.2
                          Stas                   : {STA298854503, STA909374257, STA443006025, STA490101972...}
                          StaLoadBalance         : True
                          CertificateThumbprints : {F549AFAA29EBF61E8709F2316B3981AD503AF387}
                          GatewayAuthType        : DomainAndRSA
                          GatewayEdition         : Enterprise
                          ReceiverForWebSites    : {Citrix.StoreFront.Model.Roaming.NetScalerConfiguration.ReceiverForWebSite}
<!--NeedCopy-->

EXAMPLE 4 Read configuration package

$ImportedGateways = Read-STFNetScalerConfiguration -path "$env:USERPROFILE\desktop\GatewayConfig.zip" -GatewayIndex 0 
                           $ImportedGateways.Document.Gateways[0]
<!--NeedCopy-->

REMARKS

The populated object can be inspected as shown to show an individual gateway definition. Messages related to the import are output to the console

OUTPUT

GatewayMode            : CVPN
                          CallbackUrl            :
                          GslbAddressUri         : https://gateway.domain.com/
                          AddressUri             : https://ukgateway.domain.com/
                          Address                : https://ukgateway.domain.com:443
                          GslbAddress            : https://gateway.domain.com.com:443
                          VipAddress             : 10.0.0.1
                          Stas                   : {STA298854503, STA909374257, STA443006025, STA490101972...}
                          StaLoadBalance         : True
                          CertificateThumbprints : {F549AFAA29EBF61E8709F2316B3981AD503AF387}
                          GatewayAuthType        : Domain
                          GatewayEdition         : Enterprise
                          ReceiverForWebSites    : {Citrix.StoreFront.Model.Roaming.NetScalerConfiguration.ReceiverForWebSite}
<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Read-STFNetScalerConfiguration

March 5, 2024

Contributed by:

March 5, 2024

Contributed by:

Read-STFNetScalerConfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.String

Return Values

NetScalerConfigurationDocument

Notes

Examples

EXAMPLE 1 Read configuration package

EXAMPLE 2 Read configuration package with verbose messaging

EXAMPLE 3 Read configuration package

EXAMPLE 4 Read configuration package

In this article