Add-PASPTARule

Add-PASPTARule

SYNOPSIS

Adds a new Risky Activity rule to PTA

SYNTAX

Add-PASPTARule [-category] <String> [-regex] <String> [-score] <Int32> [-description] <String>
 [-response] <String> [-active] <Boolean> [-vaultUsersMode <String>] [-vaultUsersList <String[]>]
 [-machinesMode <String>] [-machinesList <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Adds a new Risky Activity rule in the PTA server configuration.

EXAMPLES

EXAMPLE 1

Add-PASPTARule -category KEYSTROKES -regex '(*.)risky command(.*)' -score 60 -description "Example Rule" -response NONE -active $true

EXAMPLE 2

Add-PASPTARule -category KEYSTROKES -regex '(*.)risky command(.*)' -score 60 -description "Example Rule" -response NONE -active $true -vaultUsersMode EXCLUDE -vaultUsersList UserA,UserB,UserC -machinesMode INCLUDE Computer1,Computer2,Computer3

Adds a new rule to PTA, scoped to exclude listed users, and include listed machines

EXAMPLE 3

[PSCustomObject]@{
    category    = 'SQL'
    regex       = '(.*)DROP TABLE(.*)'
    score       = 90
    description = 'Detects DROP TABLE statements'
    response    = 'TERMINATE'
    active      = $true
} | Add-PASPTARule

Adds a new PTA rule using property values from the piped object.

EXAMPLE 4

Add-PASPTARule -category WINDOWS -regex '(*.)net user(.*)' -score 45 -description "Local user account creation" -response SUSPEND -active $true -machinesMode EXCLUDE -machinesList DC01,DC02

Adds a new rule to PTA, scoped to exclude the listed machines from detection.

PARAMETERS

-category

The Category of the risky activity

Valid values: SSH, WINDOWS, SCP, KEYSTROKES or SQL

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-regex

Risky activity in regex form.

Must support all characters (including “/” and escaping characters)

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-score

Activity score.

Number must be between 1 and 100

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-description

Activity description.

The field is mandatory but can be empty

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-response

Automatic response to be executed

Valid Values: NONE, TERMINATE or SUSPEND

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-active

Indicate if the rule should be active or disabled

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: True
Position: 6
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-machinesList

List of machines to be included or excluded for detection

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-machinesMode

Indicates whether the list of machines will be processed for Suspicious Activity detection Valid values:

  • INCLUDE
    • Only machines on the list will be processed for detection
  • EXCLUDE
    • Machines on the list will not be processed for detection
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-vaultUsersList

List of accounts to be included or excluded for detection

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-vaultUsersMode

Indicates whether the list of accounts will be processed for Suspicious Activity detection Valid values:

  • INCLUDE
    • Only accounts on the list will be processed for detection
  • EXCLUDE
    • Accounts on the list will not be processed for detection
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Minimum Version CyberArk 10.4

https://pspas.pspete.dev/commands/Add-PASPTARule

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/AddNewRule.htm