Absolute - Run Script
  • 18 Sep 2024
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Absolute - Run Script

  • Dark
    Light
  • PDF

Article summary

Absolute - Run Script runs an Absolute script on each device that is the result of the saved query supplied as a trigger (or users selected in the asset table).

See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.

Note:

General Settings

  • Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
  • Configure Dynamic Values - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.

Required Fields

  • Use stored credentials from the Absolute adapter (required, default: False) - Select this option to use the first connected Absolute adapter credentials.

    Note:
    • To use this option, you must successfully configure an Absolute adapter connection.
    • The user name and the password used for the adapter connection must have the required permissions to run scripts.
  • Script UID - The system-defined unique identifier for the script.

  • Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Connecting Additional Axonius Nodes.

Additional Fields

Connection and Credentials

When Use stored credentials from the adapter is toggled off, some of the connection fields below are required to create the connection, while other fields are optional.

  • Absolute Domain (optional) - Your Absolute domain. The Absolute API access is limited to two regions:

    • Canadian Data Center (CADC) - https://api.absolute.com
    • US Data Center (USDC) - https://api.us.absolute.com
  • Data center (optional) - Specify the regional data center (must be in lowercase):

    • uscd - For the US Data Center.
    • cadc - For the Canadian Data Center.
  • Token ID and Client Secret (required) - The Absolute API requires an authentication token which consists of two parts: token ID and secret key. These are generated from the Absolute console, using a custom user role, defined by your organization, or the Guest user role.
    For more details about creating a Token ID and a Secret Key, see Working with Absolute APIs.

    Note:
    The System Administrator of your Absolute console can assign the role.
  • Verify SSL (optional) - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

  • HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

  • HTTPS Proxy User Name (optional) - The user name to use when connecting to the server using the  HTTPS Proxy.

  • HTTPS Proxy Password (optional) - The password to use when connecting to the server using the  HTTPS Proxy.

  • Title (optional) - The user-defined title of the run-script request.

  • Max run time (optional) - The maximum length of time a script is allowed to run on a device.

  • Max run time unit (optional) - The unit of time used for Max run time.

  • Display mode (optional) - The visibility of the Windows PowerShell dialog when the script runs on a device.

  • Run privileges (optional) - The permissions used to run the script.

  • Run when (optional, default: UserIsOrIsNotSigedIn) - The run condition that determines when the script is allowed to run, according to the sign-in status of the user. Valid conditions include:

    • UserIsOrIsNotSigedIn (default) - The script runs regardless of whether a user is logged in or not.
    • UserIsSignedIn - The script runs only when a user is logged in.
    • NoUserIsSignedIn - The script runs only when no user is logged in.
  • Command line (optional) - The PowerShell command line parameters used to execute the script.

  • Startup dir (optional) - The directory location used by the agent to download and run scripts on the device.

  • Always run 32 bits - Run 32-bit version: Version of PowerShell used on 64-bit Windows devices.

  • Windows script option (optional) - The configurations used to execute the PowerShell script on Windows devices.

  • Mac script option (optional) - The configurations used to execute the Bash script on Mac devices.

  • Gateway Name - Select the Gateway through which to connect to perform the action.


For more details about other Enforcement Actions available, see Action Library.


Was this article helpful?