Nexthink Recognized by SIIA as the Best Digital Employee Experience Platform Learn more

Learn more

Learn more

cookie alert

We use cookies to offer you a better browsing experience, analyze site traffic, personalize content, and serve targeted advertisements. If you continue to use this site, you consent to our use of cookies.

Nexthink Library

Network Management

Back

Network Management

Latest Version: 10.0.0.0
|
Updated on April 17, 2024
Install

Description

This Library pack is a collection of different Remote Action scripts which help obtain information about the current network configurations and its connections.Please use the links on the left menu to learn more about the function and range of action of each script.

Versions

  • 10.0.0.0 - 17 Apr 2024 - Added macOS Remote Action in "Clear DNS Cache"
  • 9.4.0.0 - 08 Feb 2023 - Removed "Get Active IP Address" Remote Action
  • 9.3.0.0 - 12 Aug 2022 - Added "Status" output in "Get Wi-fi Information" Remote Action
  • 9.2.1.0 - 22 Jul 2022 - Updated OS requirements
  • 9.2.0.1 - 22 Jul 2022 - Fixed typo in "Get WiFi Signal Strength" Remote Action
  • 9.2.0.0 - 19 Apr 2022 - Added compatibility for Windows 8.1 devices on "Get WiFi Signal Strength" Remote Action
  • 9.1.0.0 - 07 Feb 2022 - Added input parameter to Anonymize BSSID data on "Get WiFi Signal Strength" Remote Action
  • 9.0.2.0 - 03 Feb 2022 - Updated campaign error handling on "Get Wi-Fi Signal Strength" Remote Action
  • 9.0.1.0 - 12 Nov 2021 - Fixed "Get Wi-Fi Signal Strength" Remote Action to avoid errors in different languages
  • 9.0.0.1 - 07 Sep 2021 - Updated scheduling information for "Get Wi-Fi Signal Strength" Remote Action
  • 9.0.0.0 - 01 Jun 2021 - Added macOS compatibility to "Get Wi-Fi Signal Strength" and "Get Local Speed to Gateway" Remote Actions
  • 8.0.2.0 - 04 May 2021 - Updated "Get Local Speed to Gateway" Remote Action by allowing Windows version only
  • 8.0.1.0 - 12 Apr 2021 - Updated "Get Active IP Address" Remote Action by improving the custom registry key update
  • 8.0.0.0 - 08 Apr 2021 - Added "Get Active IP Address" Remote Action to gather current IP address in use for endpoints running on a VPN client
  • 7.2.2.0 - 11 Mar 2021 - Fixed "Get Wi-Fi Signal Strength" Remote Action data retrieval by obtaining the numeric values in the right format
  • 7.2.1.0 - 11 Nov 2020 - Fixed "Test Connection From Device" Remote Action
  • 7.2.0.0 - 11 Nov 2020 - Updated "Test Connection From Device" Remote Action
  • 7.1.0.0 - 09 Oct 2020 - Updated "Get Wi-Fi Signal Strength" Remote Action
  • 7.0.1.0 - 17 Aug 2020 - Improved error messaging on "Get Local Speed to Gateway" Remote Action
  • 7.0.0.0 - 29 Jun 2020 - Added "Get Local Speed to Gateway" Remote Action
  • 6.0.0.0 - 19 May 2020 - Added "Get Interface Connection Status" Remote Action
  • 5.3.0.0 - 07 May 2020 - Improved "Get Wi-Fi Signal Strength" Remote Action
  • 5.2.0.0 - 24 Apr 2020 - Removed "Get Internet Speed" Remote Action
  • 5.1.0.0 - 22 Apr 2020 - Renamed "Get Connection Speed" Remote Action to "Get Internet Speed"
  • 5.0.0.0 - 21 Apr 2020 - Added "Get Connection Speed" Remote Action
  • 4.0.1.0 - 16 Apr 2020 - Downgraded "Get Wi-Fi Signal Strength" campaign
  • 4.0.0.0 - 07 Apr 2020 - Added "Get Wi-Fi Signal Strength" Remote Action
  • 3.0.1.0 - 23 Jan 2020 - Fixed "Clear DNS Cache" Remote Action
  • 3.0.0.0 - 23 Jan 2020 - Added "Clear DNS Cache" Remote Action
  • 2.0.1.0 - 19 Dec 2019 - Fixed documentation
  • 2.0.0.0 - Added "Get Wi-Fi Information" Remote Action
  • 1.1.0.0 - Updated "Get Network Configuration" Remote Action
  • 1.0.0.0 - Initial release

Required Products

Nexthink Act
Nexthink Engage

Platforms

Windows 7 and newer

Compatibility

V6.14 and later

This Might Interest You

Workflow: Windows 11 migration
New

Orchestrate the Windows 11 migration process with automated compatibility checks and pre-to-post migration user engagement.

Released on April 11, 2024
View Library Pack

Workflow: Device assignment verification
New

Orchestrate the verification and update of device assignee information in the ServiceNow Hardware Asset Management database through a dedicated workflow.

Released on April 10, 2024
View Library Pack

Get Network Configuration

Script Description

Returns the current network configurations for all connected adapters (adapter name, MAC and IP addresses, Subnet Mask, Gateway, Domain, DNS, speed, DHCP), the list of the disconnected adapters with their MAC address and WiFi information like the SSID, channel and signal strength. Useful for troubleshooting network-related issues.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
Connected Adapters StringList Current network configuration for the adapters with state "connected"
Other Connected Adapters StringList Current network configuration for the adapters with state "connected" (used only if more than 4 connected adapters exist)
WiFi Information StringList Information regarding the WiFi connection, like SSID, signal strength, channel, etc.
Disconnected Adapters StringList Name and MAC address of the adapters with state "disconnected"

Get Wi-Fi Information

Script Description

Get information about Wi-Fi connection on the device using Microsoft Windows built-in netsh.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
SSID String Wi-Fi network name
BSSID String Basic Service Set Identifier is the MAC address of the wireless access point
Radio String The network band your device can support
Channel Int Channel number used in the connection
Signal Ratio Strength of the signal the device is receiving
Status String Connection status of the Wireless interface

Test Scenarios

TestInVirtualMachines
Test Case Netsh crashes due to the lack of Wi-Fi adapter available.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failed - Netsh execution crashes.
WiFiAdapterDisconnected
Test Case Wi-Fi adapter available but not connected to any network.
Environment VM Windows 10 x64 EN 1903 with Intel(R) Dual Band Wireless-AC 8260
Results Failed - Wi-Fi adapter is not connected.
WiFiAdapterConnected
Test Case Wi-Fi adapter available and connected to a network.
Environment VM Windows 10 x64 EN 1903 with Intel(R) Dual Band Wireless-AC 8260
Results Success - Fields are retrieved correctly.

Test Connection From Device

Script Description

Performs connection test using ICMP protocol, and if port is specified also TCP connection to target destination. Allows a destination in a IPv4 or domain name format.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid overloading target destination with too many connections. Provide number of seconds less than 600
Destination Destination name, accepted values are IPv4 and domain names, provided with port if necessary. Examples are "192.168.1.1", "nexthink.com", "google.com:8080"
Timeout In Milliseconds Default value of tested connection timeout. Should be adjusted, depending on the performance of tested network route. Provide number of milliseconds between (1000, 60000)

Outputs

Label Type Description
Reachable Over ICMP Bool Result of a connection test using ICMP protocol from a device to given destination
Reachable Over TCP Bool Result of a connection test using TCP protocol from a device to given destination
Response Time Millisecond Time in milliseconds that a web request takes to reach the caller
Packet Loss Ratio Percentage of packets that are lost during a client/server two way communication

Further Information

Connection is performed using system account. In scenarios with web proxy authentication test may result in fail due to denied access.

Test Scenarios

IPDomainWithPortICMPPossibleTCPPossible
Test Case The Remote Action Receives a valid IP/Domain name with a port and tries to connect.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - ICMP and TCP connections are possible.
IPDomainWithoutPortICMPPossible
Test Case The Remote Action Receives a valid IP/Domain name without a port and tries to connect.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - ICMP connection is possible but TCP one is not.
IPDomainWithPortICMPNotPossibleTCPNotPossible
Test Case The Remote Action Receives a valid IP/Domain name with a port and tries to connect.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - None of the connections are possible.

Clear DNS Cache

Script Description

Clears DNS cache and helps to solve some possible network issues.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

None.

Test Scenarios

DNSCacheCleared
Test Case DNS Cache is cleared.
Environment Windows 10 - Windows 11
Results Success - After the execution, the DNS cache list has fewer items.
DNSCacheCleared
Test Case DNS Cache is cleared.
Environment VM macOS 10.15, 11, 12, 13
Results Success - After the execution, the DNS cache list has fewer items.

Get Wi-Fi Signal Strength

Script Description

Retrieves Wi-Fi signal quality, strength and channel, as well as whether the device is connected to a corporate network or not.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed every 1 hour.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Corporate Networks Comma-separated list of SSIDs which are defined as corporate. It can be empty
Acceptable Signal Quality Minimum signal quality percentage to consider the current wireless network as good (0 to 100)
Nearby Networks Acceptable Signal Quality Minimum signal quality percentage to consider nearby networks to be competing with the current wireless network (0 to 100)
Nearby Networks Maximum Signal Difference Maximum signal percentage difference between the current wireless network and the available networks to consider them as competing (0 to 100)
Alert User After Bad Signals Number of times (1 to 200) the signal has to be under the acceptable threshold during current day to notify the user via a campaign
Anonymize BSSID If set to 'true' BSSID data for Wifi networks will not be displayed 'ANONYMIZED' will be shown
Campaign Id Campaign to show to recommend to get closer to the router. Use an empty GUID (00000000-0000-0000-0000-000000000000) or '' to avoid campaign

Outputs

Label Type Description
Connected To Corporate Wi Fi Bool If the device is connected to a wireless network categorized as corporate
Wi Fi Signal Quality Ratio Signal quality percentage as presented by Windows
Wi Fi Signal Quality Average Ratio Wi-Fi signal quality average during the current day
Wi Fi Strength In Dbm Float Signal strength in dBm
Bad Signal Count Int Number of times the Wi-Fi signal quality was below the acceptable signal threshold during the current day
Bad Signal Percentage Ratio Percentage of time the Wi-Fi signal quality was below the acceptable signal threshold during the current day
Wi Fi Speed BitRate Speed of the connected wireless network in Mbps (Megabits per second)
Wi Fi Radio Type String Radio type used by the device's adapter connected to the active wireless network
Wi Fi Channel Int Channel used by the active wireless network
Co Channel Congestion Bool If there is noise caused by competing networks using the same channel as the active wireless network
Co Channels List StringList Details of the co-channel competing networks if there are any. The list is in CSV format
Adjacent Channels Congestion Bool If there is noise caused by competing networks using adjacent channels with respect to the active wireless network
Adjacent Channels List StringList Details of the adjacent competing networks if there are any. The list is in CSV format

Further Information

The Windows Remote Action informs users who have a connection strength lower than the threshold specified that their connection is not good for optimal work.

The macOS Remote Action only works on devices connected to a wireless network (Wi-Fi).

Note: use as empty input value '""' for Windows and '-' for macOS. This input parameter is defined as dynamic with the available two options.

Test Scenarios

UserInCorporateWiFi
Test Case The user is working in a corporate network
Environment Windows 10 x64 (English) (1903)
Results The campaign is not shown, strength is returned no other checks performed
UserWorkingFromHome1
Test Case The user is working from home and has good strength
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results The campaign is not shown, strength is returned and all the checks are performed
UserWorkingFromHome2
Test Case The user is working from home and has poor strength
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results The campaign is shown, strength and user feedback is returned
UserConnectedViaCable
Test Case The user is connected via cable
Environment VM Windows 7 x86/x64 (Multi-language) - Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results A message is displayed with the default outputs
NetworkNoiseCausedByCoChannels
Test Case The user is connected to a network that is using the same channel than others nearby
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results Success - 'CoChannelCongestion' output is true. 'CoChannelsList' output contains a list of co-channel networks, in CSV format
NetworkNoiseCausedByAdjacentChannels
Test Case The user is connected to a network that is using a channel that is intersecting other networks' frequencies
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results Success - 'AdjacentChannelsCongestion' output is true. 'AdjacentChannelsList' output contains a list of adjacent channel networks, in CSV format

Get Interface Connection Status

Script Description

Gets the interface current connection operational status, i.e., whether it is up or down, and the duration of such connection.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Interface Alias The name of the Interface which status and connection time we want to retrieve
DNS Domain The name of the DNS Domain which is associated to the network adapter that we are using

Outputs

Label Type Description
Interface Operational Bool This field will denote whether the Interface is 'Up' or not
Connection Duration Millisecond This field will indicate the time since an IP was leased through a DHCP mechanism

Further Information

Some VPN Adapters will remove the Connection Interface instead of setting it down; the Remote Action execution will fail in these cases.

Test Scenarios

CorrectRetrievalByNameConnectionUp
Test Case The status of the connection and its duration can be retrieved correctly when the connection is 'Up' - Match by Name
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Interface is operational and the duration of the connection is higher than zero
CorrectRetrievalByNameConnectionDown
Test Case The status of the connection and its duration can be retrieved correctly when the connection is not 'Up' - Match by Name
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Interface is not operational and the duration of the connection is zero
CorrectRetrievalByDescriptionConnectionUp
Test Case The status of the connection and its duration can be retrieved correctly when the connection is 'Up' - Match by Description
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Interface is operational and the duration of the connection is higher than zero
CorrectRetrievalByDescriptionConnectionDown
Test Case The status of the connection and its duration can be retrieved correctly when the connection is not 'Up' - Match by Description
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Interface is not operational and the duration of the connection is zero
FailedRetrievalUnknownAlias
Test Case Unable to retrieve details if the Interface Alias does not exist
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Execution fails and statuses are not retrieved
FailedRetrievalUnknownDNS
Test Case Unable to retrieve details if the DNS domain does not exist
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Execution fails and statuses are not retrieved

Get Local Speed to Gateway

Script Description

Retrieves the linkspeed and performs a test of latency and packet loss percentage against the default gateway.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid network overload. Provide number of seconds lower than 600

Outputs

Label Type Description
Link Speed BitRate The speed at which the device is linked to the gateway
Round Trip Time Millisecond Response time in milliseconds obtained from the gateway
Packet Loss Percentage Ratio Percentage of packet loss

Test Scenarios

WiredConnection
Test Case The connection is wired
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - LinkSpeed field shows the interface speed (1Gbps or 10Gbps), RTT and packet loss ratio are retrieved correctly
WiFiConnection
Test Case The connection is through Wi-Fi
Environment Windows 10 x64 (EN) 1909 with Wi-Fi 5
Results Success - LinkSpeed field shows the Wi-Fi speed (866 Mbps), RTT and packet loss ratio are retrieved correctly
GatewayNotPingable
Test Case The obtained gateway does not allow ICMP requests
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - LinkSpeed field shows the interface speed (1Gbps or 10Gbps), RTT is 0ms and packet loss ratio is 100%
WiredConnection
Test Case The connection is wired
Environment VM macOS 10.15 - VM macOS 11.2
Results Success - LinkSpeed field shows the interface speed (1Gbps or 10Gbps), RTT and packet loss ratio are retrieved correctly
WiFiConnection
Test Case The connection is through Wi-Fi
Environment VM macOS 10.15 - VM macOS 11.2
Results Success - LinkSpeed field shows the Wi-Fi speed (866 Mbps), RTT and packet loss ratio are retrieved correctly
GatewayNotPingable
Test Case The obtained gateway does not allow ICMP requests
Environment VM macOS 10.15 - VM macOS 11.2
Results Success - LinkSpeed field shows the interface speed (1Gbps or 10Gbps), RTT is 0ms and packet loss ratio is 100%