Set-PASMasterPolicy

Set-PASMasterPolicy

SYNOPSIS

Updates Master Policy

SYNTAX

Set-PASMasterPolicy [-PolicyId <Int32>] [[-DualControl] <Boolean>] [[-MultiLevelApproval] <Boolean>]
 [[-OnlyManagersApproval] <Boolean>] [[-ConfirmersNumber] <Int32>] [[-EnforceExclusiveAccess] <Boolean>]
 [[-EnforceOneTimePassword] <Boolean>] [[-TransparentConnection] <Boolean>] [[-AllowViewPassword] <Boolean>]
 [[-RequireReason] <Boolean>] [[-AllowFreeText] <Boolean>] [[-PasswordChangeDays] <Int32>]
 [[-PasswordVerificationDays] <Int32>] [[-RequireMonitoringAndIsolation] <Boolean>]
 [[-RecordActivity] <Boolean>] [[-RetentionPeriod] <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Allows a Vault Admin to update Master Policy Settings

EXAMPLES

Example 1

Set-PASMasterPolicy -DualControl $false

Disables Dual Control in master Policy

Example 2

Set-PASMasterPolicy -DualControl $true -ConfirmersNumber 2 -RequireReason $true

Enables Dual Control in the Master Policy, sets the required number of confirmers to 2, and requires a reason to be entered before an account can be accessed.

Example 3

Set-PASMasterPolicy -RecordActivity $true -RetentionPeriod 90 -WhatIf

Shows what would happen if session recording were enabled with a 90 day retention period, without applying the change.

Example 4

2 | Set-PASMasterPolicy -DualControl $true

Enables Dual Control on policy ID 2, received from the pipeline. Managing a policy other than the default Master Policy (ID 1) requires CyberArk version 15.0 or later.

PARAMETERS

-AllowFreeText

Allow free text reason.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-AllowViewPassword

Allow view password policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ConfirmersNumber

Configure number of confirmers policy.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DualControl

Set Dual control policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-EnforceExclusiveAccess

Enforce exclusive access policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-EnforceOneTimePassword

Enforce one-time password policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-MultiLevelApproval

Configure Multi-level approvals.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-OnlyManagersApproval

Configure approval by managers only policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-PasswordChangeDays

Password change frequency policy.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-PasswordVerificationDays

Password verification frequency policy.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-RecordActivity

Record activity policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RequireMonitoringAndIsolation

Require monitoring and isolation policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RequireReason

Require reason policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RetentionPeriod

Retention period policy.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-TransparentConnection

Transparent connection policy.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
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

-PolicyId

The ID of the policy to update.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1
Accept pipeline input: True (ByPropertyName, ByValue)
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

System.Boolean

System.Int32

OUTPUTS

System.Object

NOTES

https://pspas.pspete.dev/commands/Set-PASMasterPolicy

https://docs.cyberark.com/pam-self-hosted/latest/en/content/webservices/update-policy-by-id.htm