Functions/Safes/Set-PASSafe.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# .ExternalHelp psPAS-help.xml
function Set-PASSafe {
    [CmdletBinding(SupportsShouldProcess,
        DefaultParameterSetName = "Update")]
    param(
        [Parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Update"
        )]
        [Parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Days"
        )]
        [Parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = "Versions"
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { $_ -notmatch ".*(\\|\/|:|\*|<|>|`"|\.|\||^\s).*" })]
        [ValidateLength(0, 28)]
        [string]$SafeName,

        [Parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { $_ -notmatch ".*(\\|\/|:|\*|<|>|`"|\.|\||^\s).*" })]
        [ValidateLength(0, 28)]
        [string]$NewSafeName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [ValidateLength(0, 100)]
        [string]$Description,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [boolean]$OLACEnabled,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false
        )]
        [string]$ManagingCPM,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = "Versions"
        )]
        [ValidateRange(1, 999)]
        [int]$NumberOfVersionsRetention,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = "Days"
        )]
        [ValidateRange(1, 3650)]
        [int]$NumberOfDaysRetention
    )

    BEGIN { }#begin

    PROCESS {

        #Create URL for Request
        $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Safes/$($SafeName |

            Get-EscapedString)"


        $BoundParameters = $PSBoundParameters | Get-PASParameter -ParametersToRemove SafeName, NewSafeName

        if ($PSBoundParameters.ContainsKey("NewSafeName")) {
            $BoundParameters["SafeName"] = $PSBoundParameters["NewSafeName"]
        }

        #Create Request Body
        $body = @{
            "safe" = $BoundParameters

        } | ConvertTo-Json

        if ($PSCmdlet.ShouldProcess($SafeName, "Update Safe Properties")) {

            #Send request to web service
            $result = Invoke-PASRestMethod -Uri $URI -Method PUT -Body $Body -WebSession $Script:WebSession

            If ($null -ne $result) {

                $result.UpdateSafeResult | Add-ObjectDetail -typename psPAS.CyberArk.Vault.Safe

            }

        }

    }#process

    END { }#end

}