Skip to main content
insightsoftware Docs insightsoftware Docs
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

Administrate Jet Service Tier with the Jet Services Administration Shell

This information applies to Jet version 2019R2 and higher

Jet Services Administration Shell

The Jet Services Administration Shell (a PowerShell management module) can be used to manage the settings for the Jet Service Tier and create/maintain the certificate bound to Jet Hub.

The available MSI file can be used (with the Windows Installer or other installation tool) to install the Administration Shell into the appropriate “Program Files” directory.

Along with the Administration Shell, the MSI also installs the service assemblies and a shortcut in the Start Menu (to access the administration shell).

Click DOWNLOAD to download a zip file containing the installer:

download.png

You access the tool by using the shortcut called “Jet Services Administration Shell”.  This must be run as administrator and will open an instance of PowerShell.

  1. New-JetServiceTierCertificate

    This command will generate a new self-signed certificate using the given parameters and installed it to LocalMachine\My and LocalMachine\Root.  It will return the SHA1 Thumbprint of the newly created certificate.

    SYNTAX

    New-JetServiceTierCertificate -CommonName <string> -SubjectAlternativeNames <string[]> -Bind
    • CommonName : Used for the Issuer and Subject.

    • SubjectAlternativeNames : Will allow the certificate to be used for TLS connections.

    • Bind : Will bind the newly created certificate as the SSL certificate for the Jet Service Tier.

    Example :

    PS> New-JetServiceTierCertificate -CommonName "// JST Cert \\" -SubjectAlternativeNames  "localhost", "127.0.0.1", "DESKTOP-BTRSLHE"

    DEE05A0AEB829BEBF3B010D59AE934C9B263EF3E

  2. Show-JetServiceTierCertificate

    Shows all JST certificates thumbprints generated and installed by the New-JetServiceTierCertificate command.

    Syntax

    Show-JetServiceTierCertificate

    Example

    PS> Show-JetServiceTierCertificate 3BCE6C8879A9C22596E45D70B38AA5746BE2A67D

  3. Remove-JetServiceTierCertificate

    This command will delete the specified JST certificate from LocalMachine\My and LocalMachine\Root. It will only delete the certificates generated and installed by the New-JetServiceTierCertificate command.

    Syntax

    Remove-JetServiceTierCertificate -Thumbprints <string[]>

    Examples

    (Remove a single certificate)

    PS> Remove-JetServiceTierCertificate -Thumbprints "3BCE6C8879A9C22596E45D70B38AA5746BE2A67D"

    (Remove all certificates)

    PS> Show-JetServiceTierCertificate | Remove-JetServiceTierCertificate

  4. Get-JetServiceTierSettings

    This command will display all or just the specified JST setting(s).

    Syntax

    Get-JetServiceTierSettings [-SettingNames {IdentityServerEndpoint
                | NetTcpPort | HttpsPort | ServiceHostName | DatabaseServer
                | DatabaseName | DatabaseSecurity | DatabaseUsername | DatabaseUserPassword
                | Thumbprint | AllowSelfSignedJetHubSSLCertificates }]					

    Examples

    PS> Get-JetServiceTierSettings

    IdentityServerEndpoint=https://localhost/identity, NetTcpPort=7091, HttpsPort=7090, ServiceHostName=localhost, DatabaseServer=(local), DatabaseName=JetServices_20, DatabaseSecurity=SqlAuth, DatabaseUsername=Jet, DatabaseUserPassword=Jet Thumbprint=dee05a0aeb829bebf3b010d59ae934c9b263ef3e

    PS> Get-JetServiceTierSettings -SettingNames HttpsPort, DatabaseName HttpsPort=7090 DatabaseName=JetServices_20

  5. Set-JetServiceSettings

    This command sets the specified JST setting. Changing some settings will require the restart of the JST for the change to take effect. The command will prompt the user to confirm the service restart.

    Valid NetTcpPort/HttpsPort port range is 1024 - 65535. The command will also validate the specified port is open before setting the value. The -ForceSave parameter will force the saving of the -HttpsPort or -NetTcpPort values regardless if those ports are currently open. Indented to facilitate unit testing but it can also be handy in some unusual developer cases.

    Syntax

    Set-JetServiceTierSettings [-IdentityServerEndpoint <string>][-NetTcpPort <int>][-HttpsPort <int>][-ServiceTierHost <string>][-DatabaseServer <string>][-DatabaseName <string>][-DatabaseSecurity {SqlAuth | Windows}][-DatabaseUsername <string>][-DatabaseUserPassword <string>][-AllowSelfSignedJetHubSSLCertificates <bool>][-RefreshPivotTables <bool>][-ForceSave]
    RefreshPivotTables will turn on/off the auto-refresh of pivot tables

    Examples

     
    								
            PS> Set-JetServiceTierSettings -DatabaseName  JetServices_2.8.0
    								
    							
    								
            PS> Set-JetServiceTierSettings -DatabaseSecurity SqlAuth -DatabaseUsername Jet -DatabaseUserPassword Jet
    								
    							
    								
            Confirm
    								
    																
            The Jet Service Tier will not be functional until it is restarted. Restart the Jet Service Tier?
    								
    																
            [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):
    								
    							
    								
            PS> Set-JetServiceTierSettings -HttpsPort 7090
    								
    																
            Set-JetServiceTierSettings : The specified port 7090 is not available.
    								
    																
            At line:1 char:1
    								
    																
            + Set-JetServiceTierSettings -HttpsPort 7090
    								
    																
            + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    								
    																
            + CategoryInfo : InvalidOperation: (:) [Set-JetServiceTierSettings], Exception
    								
    																
            + FullyQualifiedErrorId : Jet.Services.Management.SetJetServiceTierSettingsCommand
    								
    							

Published:

Administrate Jet Service Tier with the Jet Services Administration Shell

This information applies to Jet version 2019R2 and higher

Jet Services Administration Shell

The Jet Services Administration Shell (a PowerShell management module) can be used to manage the settings for the Jet Service Tier and create/maintain the certificate bound to Jet Hub.

The available MSI file can be used (with the Windows Installer or other installation tool) to install the Administration Shell into the appropriate “Program Files” directory.

Along with the Administration Shell, the MSI also installs the service assemblies and a shortcut in the Start Menu (to access the administration shell).

Click DOWNLOAD to download a zip file containing the installer:

download.png

You access the tool by using the shortcut called “Jet Services Administration Shell”.  This must be run as administrator and will open an instance of PowerShell.

  1. New-JetServiceTierCertificate

    This command will generate a new self-signed certificate using the given parameters and installed it to LocalMachine\My and LocalMachine\Root.  It will return the SHA1 Thumbprint of the newly created certificate.

    SYNTAX

    New-JetServiceTierCertificate -CommonName <string> -SubjectAlternativeNames <string[]> -Bind
    • CommonName : Used for the Issuer and Subject.

    • SubjectAlternativeNames : Will allow the certificate to be used for TLS connections.

    • Bind : Will bind the newly created certificate as the SSL certificate for the Jet Service Tier.

    Example :

    PS> New-JetServiceTierCertificate -CommonName "// JST Cert \\" -SubjectAlternativeNames  "localhost", "127.0.0.1", "DESKTOP-BTRSLHE"

    DEE05A0AEB829BEBF3B010D59AE934C9B263EF3E

  2. Show-JetServiceTierCertificate

    Shows all JST certificates thumbprints generated and installed by the New-JetServiceTierCertificate command.

    Syntax

    Show-JetServiceTierCertificate

    Example

    PS> Show-JetServiceTierCertificate 3BCE6C8879A9C22596E45D70B38AA5746BE2A67D

  3. Remove-JetServiceTierCertificate

    This command will delete the specified JST certificate from LocalMachine\My and LocalMachine\Root. It will only delete the certificates generated and installed by the New-JetServiceTierCertificate command.

    Syntax

    Remove-JetServiceTierCertificate -Thumbprints <string[]>

    Examples

    (Remove a single certificate)

    PS> Remove-JetServiceTierCertificate -Thumbprints "3BCE6C8879A9C22596E45D70B38AA5746BE2A67D"

    (Remove all certificates)

    PS> Show-JetServiceTierCertificate | Remove-JetServiceTierCertificate

  4. Get-JetServiceTierSettings

    This command will display all or just the specified JST setting(s).

    Syntax

    Get-JetServiceTierSettings [-SettingNames {IdentityServerEndpoint
                | NetTcpPort | HttpsPort | ServiceHostName | DatabaseServer
                | DatabaseName | DatabaseSecurity | DatabaseUsername | DatabaseUserPassword
                | Thumbprint | AllowSelfSignedJetHubSSLCertificates }]					

    Examples

    PS> Get-JetServiceTierSettings

    IdentityServerEndpoint=https://localhost/identity, NetTcpPort=7091, HttpsPort=7090, ServiceHostName=localhost, DatabaseServer=(local), DatabaseName=JetServices_20, DatabaseSecurity=SqlAuth, DatabaseUsername=Jet, DatabaseUserPassword=Jet Thumbprint=dee05a0aeb829bebf3b010d59ae934c9b263ef3e

    PS> Get-JetServiceTierSettings -SettingNames HttpsPort, DatabaseName HttpsPort=7090 DatabaseName=JetServices_20

  5. Set-JetServiceSettings

    This command sets the specified JST setting. Changing some settings will require the restart of the JST for the change to take effect. The command will prompt the user to confirm the service restart.

    Valid NetTcpPort/HttpsPort port range is 1024 - 65535. The command will also validate the specified port is open before setting the value. The -ForceSave parameter will force the saving of the -HttpsPort or -NetTcpPort values regardless if those ports are currently open. Indented to facilitate unit testing but it can also be handy in some unusual developer cases.

    Syntax

    Set-JetServiceTierSettings [-IdentityServerEndpoint <string>][-NetTcpPort <int>][-HttpsPort <int>][-ServiceTierHost <string>][-DatabaseServer <string>][-DatabaseName <string>][-DatabaseSecurity {SqlAuth | Windows}][-DatabaseUsername <string>][-DatabaseUserPassword <string>][-AllowSelfSignedJetHubSSLCertificates <bool>][-RefreshPivotTables <bool>][-ForceSave]
    RefreshPivotTables will turn on/off the auto-refresh of pivot tables

    Examples

     
    								
            PS> Set-JetServiceTierSettings -DatabaseName  JetServices_2.8.0
    								
    							
    								
            PS> Set-JetServiceTierSettings -DatabaseSecurity SqlAuth -DatabaseUsername Jet -DatabaseUserPassword Jet
    								
    							
    								
            Confirm
    								
    																
            The Jet Service Tier will not be functional until it is restarted. Restart the Jet Service Tier?
    								
    																
            [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):
    								
    							
    								
            PS> Set-JetServiceTierSettings -HttpsPort 7090
    								
    																
            Set-JetServiceTierSettings : The specified port 7090 is not available.
    								
    																
            At line:1 char:1
    								
    																
            + Set-JetServiceTierSettings -HttpsPort 7090
    								
    																
            + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    								
    																
            + CategoryInfo : InvalidOperation: (:) [Set-JetServiceTierSettings], Exception
    								
    																
            + FullyQualifiedErrorId : Jet.Services.Management.SetJetServiceTierSettingsCommand
    								
    							

For an optimal Community experience, Please view on Desktop