Skip to content

Commit

Permalink
Updated with Connection Examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Nillth committed Sep 9, 2022
1 parent 31a551a commit 3494f01
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,66 @@ Issues can be reported via the GitHub Repository [Issues](https://github.com/Qli

Further information around the QRS API's can be found in the [OpenAPI](https://help.qlik.com/en-US/sense-developer/APIs/RepositoryServiceAPI/index.html) specification

## Installation
```PowerShell
Get-PackageProvider -Name NuGet -ForceBootstrap
# Install for all users, requires admin rights
Install-Module QlikSenseCLI
# Install for current user
Install-Module QlikSenseCLI -Scope CurrentUser
```

```PowerShell
# Once Installed you can import the Module
Import-Module QlikSenseCLI
# Then to Connect to Qlik Sense you can use one of the following with the Optional Parameters
# Current User
Connect-QlikSense [[-Hostname] <string>] [[-VirtualProxy] <string>] [[-TrustAllCertificates]]
# Specified Credentials
Connect-QlikSense [[-Hostname] <string>] [[-VirtualProxy] <string>] [[-Credential] <NetworkCredential>] [[-TrustAllCertificates]]
# Qlik Client Certificate
Connect-QlikSense [[-Hostname] <string>] [[-Username] <string>] [[-Certificate] <X509Certificate2>][[-TrustAllCertificates]]
```

### Connection Examples
```PowerShell
# Connect to local host as current user
Connect-QlikSense
# Connect to local host as current user on specific virtual proxy
Connect-QlikSense -VirtualProxy "MyVP" -TrustAllCertificates
# Connect to Remote host on specific Virtual proxy as the current user
Connect-QlikSense -Hostname "MySenseServer" -VirtualProxy "MyVP" -TrustAllCertificates
```

```PowerShell
# Connect to Local host with Specified Credentials
$Credentials = Get-Credential
Connect-QlikSense -Credential $Credentials -TrustAllCertificates
# Connect to Remote host on with Specified Credentials on specific Virtual proxy
$Credentials = Get-Credential
Connect-QlikSense -Hostname "MySenseServer" -VirtualProxy "MyVP" -Credential $Credentials -TrustAllCertificates
```

```PowerShell
# Connect to Local host on with QlikClient Certificate as Specified User
$QlikClientCertificate = Get-ChildItem Cert:\CurrentUser\My\ | ? { $_.Subject -eq "CN=QlikClient" }
Connect-QlikSense -Certificate $QlikClientCertificate -Username "Domain\User" -TrustAllCertificates
# Connect to Remote host on with QlikClient Certificate as Specified User
$QlikClientCertificate = Get-ChildItem Cert:\CurrentUser\My\ | ? { $_.Subject -eq "CN=QlikClient" }
Connect-QlikSense -Hostname "MySenseServer" -Certificate $QlikClientCertificate -Username "Domain\User" -TrustAllCertificates
```



### TO DO
Usage examples Coming soon!

0 comments on commit 3494f01

Please sign in to comment.