Online Help

Tools

Preview

Tools a feature that enables you to execute PowerShell commands and scripts on audited or discovered computers or network devices from AlloyScan. Out of the box, a variety of default tools are provided, offering functionalities such as connecting via VNC, initiating telnet sessions, or performing simple ping operations on target machines. You can also customize the default tools and incorporate custom scripts and commands.

Default tools

The default list of tools includes the following:

  • Telnet: Connects to the selected computer through the network using the Telnet protocol.

  • Ping: Sends a ping request to the chosen computer to determine if it responds and measures the time it takes to receive a reply.

  • VNC (Virtual Network Computing): Controls the selected computer over a network connection using Virtual Network Computing. Note that this default setup is provided for demonstration purposes only. To execute the VNC command, the VNC viewer must be installed on the machine hosting the network inventory. The VNC server should be installed on the selected client machine, and the "VNC" integration should be pointed to the executable file vncviewer.exe.

  • Remote Desktop (RDC): Allows control of the selected computer through a network connection using Remote Desktop Connection.

  • Open in Windows Explorer: Accesses the shared resources of the computer using Windows Explorer.

  • Manage: Opens the Computer Management console for the selected computer.

  • Trace Route: Determines the network path to the selected computer.

  • Event Viewer: Launches the Event Viewer for the selected computer.

  • Path Ping: Provides detailed information about the network path to the destination computer and retrieves ping-like statistics for each node along the path.

  • Task List: Displays a list of applications and services for all tasks running on the selected computer.

  • Shutdown: Initiates the shutdown process for the selected computer. Upon receiving the Shutdown command, the computer will display a message indicating the system is shutting down and will commence a countdown. Users on the remote computer can cancel the shutdown process by entering shutdown -a at the command prompt.

  • Reboot: Restarts the selected computer.

  • WakeOnLan: Powers on the chosen computer via a network connection using the WakeOnLan utility included with AlloyScan. Note that executing the WakeOnLan command requires the target computer to meet the technical requirements of the Wake on LAN (WOL) standard. Additionally, adjustments to the target computer's BIOS configuration may be necessary.

NOTE: The default integrations require the existence of their respective external programs on your computer.

Running tools

To launch a tool for a computer or device, open the target node details in the Inventory or Network section, click Tools and select the required tool from the pop-up menu.

NOTE: Tools are run from Alloy Integration Launcher. This lightweight program is automatically activated upon selecting a tool.

Configuring and managing tools

The My organization | Settings | Tools section in the Admin Center is where you can add new tools, edit existing tools, and delete tools that are no longer needed.

Creating tools and editing their properties

Clicking New tool in the Tools section opens the New tool pane, where you can configure a specific tool.

When you select a computer and launch a tool, AlloyScan executes the PowerShell script or command specified in the tool's configuration. Command parameters specified using placeholders are replaced with actual values from that computer's audit snapshot. For example, a placeholder for IP address is replaced with the actual IP address of the client computer.

IMPORTANT: The version of PowerShell on your computer must match the version of your PowerShell script or command, or be higher.

Enter the following parameters:

  • Caption: This is the name of the tools as it appears in the list. The caption must be unique and cannot be left blank. To include a keyboard accelerator, which follows the standard Windows ALT+<character> combination, include an ampersand (&) before the character. For example, to use the ALT+D combination as an accelerator for the Remote Desktop tool, enter the caption as Remote &Desktop. To display the ampersand character in the caption, use two ampersands (&&).

  • Run: A PowerShell commands or script to run. It can consist of a PowerShell cmdlet, a combination of cmdlets, a script, or any external program.

    To enter a dynamic parameter, click the Placeholder icon . Two type of placeholders are available:

    • Data placeholders: Built-in placeholders for inventory data, such as IP address, device name, or MAC address.

    • Password placeholders: Custom placeholders for passwords. For details, see Passing encrypted passwords.

    Select a placeholder and click Insert. At runtime, all placeholders will be replaced by the actual data.

    TIP: If an argument for your executable command requires the placeholder value to be enclosed in quotes, you must add them manually in the command editor. AlloyScan does not perform additional wrapping of placeholder values in double quotes.
    For example: sshpass -p "%[MyPass]%" ssh root@%[AD.IP_ADDRESS]%"

    INFO: For additional information, see Microsoft PowerShell documentation at https://docs.microsoft.com/powershell/.

  • Display PowerShell window: Select this checkbox if you wish to keep the PowerShell window open after the command is executed to review the information in it.

Click Create.

Passing encrypted passwords

If you need to pass a password to a tool's command or script, create a placeholder that will securely store the encrypted password, and then use that placeholder in your script. This approach ensures that sensitive information remains encrypted and secure, enhancing overall data protection.

To create a password placeholder:

  1. In the Admin Center, navigate to My organization > Settings > Tools and click Passwords.

  2. In the Passwords pane, click New password and enter the following details:

    • Placeholder: Provide a name for your placeholder. This name will be used in your scripts or commands.

    • Description: Add a brief description to help identify the password placeholder when inserting it.

    • Password / Confirm password: Enter and confirm the password. The password will be encrypted immediately upon entry.

  3. Click Save to apply and save your changes.

To use a password placeholder:

  1. In the Admin Center, navigate to My organization > Settings > Tools and click New tool to add a new tool or double-click an existing one to modify it.

    INFO: For details, see Creating tools and editing their properties.

  2. In the Run field, place the cursor in the location where to insert your password placeholder and click the Placeholder icon .

  3. Switch to the Password placeholders tab, select the placeholder to insert, and click Insert.

  4. Click Close to close the Placeholders pane.

  5. Make sure that the placeholder is inserted as needed and click Save to apply and save your changes.

Managing tool configuration in JSON format

In the Tools section, you can interact with tool configurations in a more technical and detailed manner using JSON format.

  • Export JSON: You can export the entire tool configuration as a JSON file. By clicking on the three-dot icon and selecting Export JSON, the current configuration is packaged into a JSON format. This is particularly useful for backup or sharing tool configuration details.

  • Edit as JSON: If you prefer a more direct and technical interaction with the tool configuration, click on the three-dot icon and select Edit as JSON to open the configuration in a separate window in a raw JSON format. You can then directly modify the configuration in this format.

Additional tool management options

To remove a tool that is no longer required, click on the respective three-dot icon and select Delete.

The three-dot icons can serve as handles for rearranging the tools by moving them up or down on the list.