Lansweeper

https://docs.lansweeper.com
Admin
Lansweeper is an IT asset intelligence and discovery platform that provides complete visibility and...
Tokens:483,553
Snippets:3,818
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Enable and start OpenSSH service

Source: https://docs.lansweeper.com/docs/linux-and-unix-scanning-requirements

Run these commands to enable SSH to start automatically and start the service. Requires sudo privileges.

```bash
sudo systemctl enable sshd
sudo systemctl start sshd
```

--------------------------------

### Set service to start automatically and start it

Source: https://docs.lansweeper.com/docs/troubleshoot-the-traffic-sensor-windows

Updates the service startup type to Automatic and starts it. Use this if the StartType is not Automatic after a reboot.

```powershell
Set-Service "Lansweeper Network Discovery Traffic Sensor Service" -StartupType Automatic
Start-Service "Lansweeper Network Discovery Traffic Sensor Service"

```

--------------------------------

### Format function examples

Source: https://docs.lansweeper.com/docs/derived-fields-function-reference

Examples showing template formatting with placeholders.

```text
Format("{} {} ({})", [Manufacturer], [Model], [Serial number])
-- → "Dell OptiPlex 7090 (ABC123XYZ)"
Format("{} has {} vulnerabilities", [Asset name], [Number of Vulnerabilities])
-- → "SRV-WEB-01 has 5 vulnerabilities"
Format("RAM: {} GB | Disks: {}", [Memory] / 1024, Length([Disk Drive Size]))
-- → "RAM: 8 GB | Disks: 3"

```

--------------------------------

### Install IT Agent Discovery package with sudo installer

Source: https://docs.lansweeper.com/docs/install-it-agent-macos

Runs the macOS installer for the IT Agent Discovery package. Replace X.X.X with the actual version number from your Lansweeper site.

```shell
sudo installer -pkg Lansweeper-IT-agent-discovery-X.X.X-osx-installer.pkg -target /
```

--------------------------------

### Install Network Discovery Hub on Ubuntu/Debian

Source: https://docs.lansweeper.com/docs/install-the-traffic-sensor

Install the hub using a linking code. Replace YourCloudTokenHere with the code generated in the UI.

```bash
sudo env LINKING_CODE=YourCloudTokenHere apt install lansweeper-network-discovery-hub
```

--------------------------------

### OAuth 2.0 Scopes Example

Source: https://docs.lansweeper.com/docs/airtable-connector

Example of space-separated scopes for OAuth 2.0 authentication, as shown in the setup steps. The default scopes include common permissions for reading, writing, and managing webhooks.

```text
data.records:read data.records:write schema.bases:read webhook:manage
```

--------------------------------

### ToStartOfWeek function signature and example

Source: https://docs.lansweeper.com/docs/derived-fields-function-reference

Truncates a date to the start of the week (Sunday by default). The signature shows the function takes a Date and returns a Date. The example truncates the 'Last successful scan' field to '2026-02-01'.

```plaintext
ToStartOfWeek(date: Date) → Date
```

```plaintext
ToStartOfWeek([Last successful scan])
-- → "2026-02-01"
```

--------------------------------

### Installation using a configuration file

Source: https://docs.lansweeper.com/classic/docs/silently-install-uninstall-or-update-lansweeper

Uses an InstallConfig.ini file to specify installation parameters for all components, with database in SQL Server and web console in IIS Express on port 81. The /silent or /verysilent parameter must be provided in the command itself, not in the config file.

```text
[GENERAL]
ACCEPTEULA="True"
ACTION="INSTALL"
PARTS="SCAN,DB,WEB"
[DATABASE]
DBSERVER="SQLServer"
DBINSTANCE="REMOTE_SERVER\SQLEXPRESS"
DBUSERCONFIG="your_db_password"
ALLOWDBOVERWRITE="True"
[WEBSERVER]
WEBSERVER="IISExpress"
HTTPPORT="81"

```

```text
LansweeperSetup.exe /silent /ConfigurationFile="C:\install_files\InstallConfig.ini"

```

--------------------------------

### ToStartOfDay function signature and example

Source: https://docs.lansweeper.com/docs/derived-fields-function-reference

Truncates a datetime to midnight (start of the day). The signature shows the function takes a Date and returns a Date. The example truncates the 'Last successful scan' field to '2026-02-03 00:00:00'.

```plaintext
ToStartOfDay(date: Date) → Date
```

```plaintext
ToStartOfDay([Last successful scan])
-- → "2026-02-03 00:00:00"
```

--------------------------------

### Run preinstall script with sudo

Source: https://docs.lansweeper.com/docs/install-it-agent-macos

Executes the preinstall script with elevated privileges to prepare the silent installation.

```shell
sudo LansweeperITAgent-PreinstallScript_stable.sh
```

--------------------------------

### Install Network Discovery Hub on Red Hat

Source: https://docs.lansweeper.com/docs/install-the-traffic-sensor

Install the hub using a linking code. Replace YourCloudTokenHere with the code generated in the UI.

```bash
sudo env LINKING_CODE=YourCloudTokenHere dnf install lansweeper-network-discovery-hub
```

--------------------------------

### Run scan with hub URI and key (Method 1)

Source: https://docs.lansweeper.com/docs/run-it-agent-discovery-portable

Starts the discovery scan by executing the portable executable with the -h flag for the hub URI and --key for the file import key. Replace the hub URL and key as appropriate.

```powershell
C:\Temp\Lansweeper-IT-Agent-Portable\Lansweeper-IT-agent-portable-X.X.X-windows-x64.exe scan -h https://mynetworkdiscoveryhub.domain.local:59525 --key fileimportkey

```

--------------------------------

### Get Deal

Source: https://docs.lansweeper.com/docs/pipedrive-connector

Gets details of a deal.

```APIDOC
## Get Deal

### Description
Gets details of a deal.

### Inputs
- **Connection** (Connection) - Required - The Pipedrive connection to use.
- **Deal ID** (string) - Required - The unique identifier for the deal.

```

--------------------------------

### Get Activity

Source: https://docs.lansweeper.com/docs/pipedrive-connector

Gets details of an activity.

```APIDOC
## Get Activity

### Description
Gets details of an activity.

### Inputs
- **Connection** (Connection) - Required - The Pipedrive connection to use.
- **Activity ID** (string) - Required - The unique identifier for the activity.

```

--------------------------------

### Install Traffic Sensor on Ubuntu/Debian

Source: https://docs.lansweeper.com/docs/install-the-traffic-sensor

Install the sensor. Replace YourCloudTokenHere and localhost with the linking code and hub location. Use the hub's IP or FQDN instead of localhost if the sensor is on a different host.

```bash
sudo env HUB_CODE=YourCloudTokenHere HUB_INSTANCE=localhost HUB_PORT=59525 apt install lansweeper-network-discovery-traffic-sensor
```

--------------------------------

### Preinstall configuration script for silent installation

Source: https://docs.lansweeper.com/docs/install-it-agent-macos

Creates the preinstall configuration file for silent installation. Sets the path, enables unattended mode, accepts the EULA, and configures the cloud token. Uncomment proxy lines if a proxy is required.

```shell
#!/bin/sh
PreinstallConfig="/tmp/LansweeperITAgent-Preinstall.cfg" # Don't change this path!
[ -f $PreinstallConfig ] && chmod 744 $PreinstallConfig
cat > $PreinstallConfig << EOF
mode=unattended
accepteula=1
path=/Library/Application Support/Lansweeper IT Agent Discovery
cloudtoken=cloudtokenvalue
#proxyserver=myproxyserver.domain.local
#proxyport=8080
EOF
chmod 744 $PreinstallConfig
```

--------------------------------

### Get File

Source: https://docs.lansweeper.com/docs/microsoft-sharepoint-connector

Gets a file from a Drive.

```APIDOC
## Get File

### Description
Get a file from a Drive.

### Inputs
| Name | Description | Default |
|------|-------------|---------|
| Connection | The Microsoft SharePoint connection to use. | |
| Drive | The unique identifier of a SharePoint drive. | |
| Item Id | The unique identifier of a SharePoint item. | |
```

--------------------------------

### Get Activity Types

Source: https://docs.lansweeper.com/docs/pipedrive-connector

Gets all activity types.

```APIDOC
## Get Activity Types

### Description
Gets all activity types.

### Inputs
- **Connection** (Connection) - Required - The Pipedrive connection to use.

```

--------------------------------

### ToString usage examples

Source: https://docs.lansweeper.com/docs/derived-fields-function-reference

Examples of converting memory, vulnerability count, warranty end date, and computed memory to strings, with expected outputs.

```text
ToString([Memory])
-- → "8192"
ToString([Number of Vulnerabilities])
-- → "5"
ToString([Warranty end date])
-- → "2026-06-15"
Concat("RAM: ", ToString([Memory] / 1024), " GB")
-- → "RAM: 8 GB"
```

--------------------------------

### Deploy Instance

Source: https://docs.lansweeper.com/docs/prismatic-connector

Deploys an instance to production. Requires a connection and an instance ID.

```APIDOC
## Deploy Instance

### Description
Deploy an instance to production.

### Inputs
- **Connection** (required) - The connection to use.
- **Instance Id** (required) - Provide the unique ID of an instance.

### Request Example
```json
{
  "connection": "<connection>",
  "instanceId": "<instance-id>"
}
```

### Response
No response body is documented.
```

--------------------------------

### Get Activity Fields

Source: https://docs.lansweeper.com/docs/pipedrive-connector

Gets all activity fields.

```APIDOC
## Get Activity Fields

### Description
Gets all activity fields.

### Inputs
- **Connection** (Connection) - Required - The Pipedrive connection to use.

```

--------------------------------

### Get Response

Source: https://docs.lansweeper.com/docs/surveymonkey-connector

Gets summary information about a specific response.

```APIDOC
## Get Response

### Description
Get summary information about a specific response. Use 'Get Response Details' for full answers.

### Inputs
- **Connection** (string) - Required - The SurveyMonkey connection to use.
- **Survey ID** (string) - Required - The unique identifier of the survey.
- **Response ID** (string) - Required - The unique identifier of the response.
```

--------------------------------

### Action: Create Onboarding Candidate Info

Source: https://docs.lansweeper.com/docs/sap-successfactors-connector

Create new onboarding candidate info.

```APIDOC
## Action: Create Onboarding Candidate Info

### Description
Create new onboarding candidate info.

### Inputs
- **Connection** (connection) - Required - The connection to use.
- **Additional Inputs** (object) - Required - The additional fields to send in the request body, as a JSON object.
```
Tokens:
Raw