PowerShell Commands
You can configure the SOTI Cloud Link Agent using PowerShell. See available commands below.
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, |
[String]Name |
Remove-CloudLinkClient |
Removes the existing SOTI Cloud Link Agent client using the specified name.
For example, |
[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, |
[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, |
[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, |
[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,
|
[String]TokenName
[Double]DurationMilliseconds |
SOTI Cloud Link Agent API Common Settings Management API
Provides access to the top-level settings (individual set
s, 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, |
[String]ApiRoot |
Set-CloudLinkPort |
Sets the SOTI Cloud Link Agent port to a specified port. A valid port number is required.
For example, |
[Int]Port |