PowerShell Commands

Note: The information in this topic only applies to inbound SOTI Cloud Link Agent.

You can configure the SOTI Cloud Link Agent using PowerShell. See available commands below.

Tip: You can also type Get-Command –Module Soti.CloudLink.PowerShell at the PowerShell command line, to retrieve a list of available commands for the SOTI Cloud Link Agent.

OAuth Client Management API

Provides client credential management.

Command Description Parameters
New-CloudLinkClient Adds a new SOTI Cloud Link Agent client with the specified name.

For example, New-CloudLinkClient Client1

 [String]Name
Remove-CloudLinkClient Removes the existing SOTI Cloud Link Agent client using the specified name.

For example, Remove-CloudLinkClient Client1

 [String]Name
Get-CloudLinkClients Retrieves the list of the existing SOTI Cloud Link Agent clients. N/A

Configuration Management API

Allows you to securely clone or import configurations.

Command Description Parameters
Export-CloudLinkConfig Exports the configuration from the SOTI Cloud Link Agent. A password is required and the Export path must be an existing relative or absolute path.

For example, Export-CloudLinkConfig 1234 C:\Program Files\SOTI\example.log

 [String]Password

[String]ExportPath
Import-CloudLinkConfig Imports the configuration to SOTI Cloud Link Agent. A password is required and the Source path must be an existing relative or absolute path.

For example, Import-CloudLinkConfig 1234 C:\Program Files\SOTI\example.log

 [String]Password

[String]SourcePath

JSON Web Token (JWT) Signer Management API

Allows you to manage JWT signer certificates. Get returns values for name, serial number, and validity period.

Command Description Parameters
Get-CloudLinkTokenSignerInfo Retrieves the SOTI Cloud Link Agent Token Signer information. N/A
Set-CloudLinkTokenSigner Sets the SOTI Cloud Link Agent Token Signer. A password is required.

For example, Set-CloudLinkTokenSigner 1111

 [String]Password
Set-CloudLinkTokenValidityPeriod Sets the SOTI Cloud Link Agent Token Validity Period. The token name can be either the API token or the User token.

For example,

  • Set-CloudLinkTokenValidityPeriod api 50000
  • Set-CloudLinkTokenValidityPeriod user 50000
 [String]TokenName

[Double]DurationMilliseconds

SOTI Cloud Link Agent API Common Settings Management API

Provides access to the top-level settings (individual sets, group get) For example, API root, Port, Token Validity Period.

Command Description Parameters
Get-CloudLinkApiSettings Retrieves the details of the SOTI Cloud Link Agent API settings. N/A
Set-CloudLinkApiRoot Sets the SOTI Cloud Link Agent API Root, and the input can be a combination of alphanumeric, ., _, ~, or -. Whitespaces and / at the start or end will be removed.

For example, Set-CloudLinkApiRoot Abc-123

 [String]ApiRoot
Set-CloudLinkPort Sets the SOTI Cloud Link Agent port to a specified port. A valid port number is required.

For example, Set-CloudLinkPort 443

 [Int]Port