CyZones.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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
<#
.SYNOPSIS
    Gets a list of all zones from the console.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER DeviceName
    Optional. Get zone list for a particular device name.
 
.PARAMETER Device
    Optional. Get zone list for a particular device.
#>

function Get-CyZoneList {
    [CmdletBinding(DefaultParameterSetName="All")] 
    Param (
        [parameter(Mandatory=$false)]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [parameter(Mandatory=$true,ParameterSetName="ByDeviceName")]
        [String]$DeviceName,
        [parameter(Mandatory=$true,ParameterSetName="ByDevice")]
        [object]$Device
        )


    switch ($PSCmdlet.ParameterSetName) {
        "ByDeviceName" {
            $Device = Get-CyDeviceList | Where-Object name -eq $DeviceName
            Get-CyZoneList -API $API -Device $Device
        }
        "ByDevice" {
            Read-CyData -API $API -Uri "$($API.BaseUrl)/zones/v2/$($Device.id)/zones"
        }
        "All" {
            Read-CyData -API $API -Uri "$($API.BaseUrl)/zones/v2"
        }
    }
}

<#
.SYNOPSIS
    Retrieves the given ZONE Detail from the console. Gets full data, not a shallow version.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAM Zone
    The zone object to fetch Detail for.
 
.PARAM ZoneName
    The zone name to fetch the zone object for.
#>

function Get-CyZone {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true,
            ParameterSetName="ByZoneObject")
            ]
            [object[]]$Zone,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true,
            ParameterSetName="ByZoneName")
            ]
            [String[]]$Name
        )

    Process {
        switch ($PSCmdlet.ParameterSetName)
        {
            "ByZoneName" {
                Write-Verbose "Get-CyZone: Getting zone by name '$($Name)'"
                Get-CyZoneList | Where-Object name -eq $Name
            }
            "ByZoneObject" {
                Write-Verbose "Get-CyZone: Getting zone via zone object for zone ID '$($Zone.id)'"
                Invoke-CyRestMethod -API $API -Method GET -Uri  "$($API.BaseUrl)/zones/v2/$($Zone.id)"
            }
        }
    }
}

<#
.SYNOPSIS
    Creates a new zone.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Name
    The name of the new zone
 
.PARAMETER Policy
    Optional. The policy for the new zone
 
.PARAMETER Criticality
    Optional. The criticality for the new zone
#>

function New-CyZone{
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
        [String[]]$Name,
        [Parameter(Mandatory=$false)]
        [object]$Policy = @{ id = $null},
        [Parameter(Mandatory=$false)]
        [ValidateSet("Low", "Normal", "High")]
        [String]$Criticality = "Normal"

    )
    Begin {
    }

    Process {
        $updateMap = @{
            "name" = $($Name)
            "policy_id" = $($Policy.id)
            "criticality" = $Criticality
        }

        $json = $updateMap | ConvertTo-Json
        Invoke-CyRestMethod -API $API -Method POST -Uri "$($API.BaseUrl)/zones/v2" -ContentType "application/json; charset=utf-8" -Body $json
    }
}

<#
.SYNOPSIS
    Removes a zone.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Name
    The name of a zone to remove
 
.PARAMETER Zone
    The zone object to remove.
#>

function Remove-CyZone {
    [CmdletBinding(DefaultParameterSetName="All")] 
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(Mandatory=$true,ParameterSetName="ByZoneName",ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
        [String]$Name,
        [Parameter(Mandatory=$false,ParameterSetName="ByZone",ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
        [object]$Zone

    )

    Begin {
    }

    Process {
        switch ($PSCmdlet.ParameterSetName) {
            "ByZoneName" {
                $Zone = Get-CyZone -API $API -Name $Name
                Remove-CyZone -API $API -Zone $Zone
            }
            "ByZone" {
                Invoke-CyRestMethod -API $API -Method DELETE -Uri "$($API.BaseUrl)/zones/v2/$($Zone.id)" -ContentType "application/json; charset=utf-8"
            }
        }
    }
}

<#
.SYNOPSIS
    Adds device(s) to zone(s).
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Zone
    The zone to add the device to.
 
.PARAMETER Device
    The device(s) to add to the zone.
#>

function Add-CyDeviceToZone {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true)]
            [object[]]$Device,
        [Parameter(Mandatory=$true)]
        [object]$Zone
    )

    Begin {
        $zoneIds = $Zone.id

        # zone IDs must be an array
        if ($zoneIds -isnot [array]) {
            $zoneIds = @($zoneIds)
        }
    }

    Process {
        if (($null -eq $Device) -or ($null -eq $Device.id) -or ([String]::IsNullOrEmpty($Device.id))) {
            throw "Add-CyDeviceToZone: Device ID cannot be null or empty."
        }

        if (($null -eq $Device.policy) -or ($null -eq $Device.policy.id) -or ([String]::IsNullOrEmpty($Device.policy.id))) {
            throw "Add-CyDeviceToZone: Device policy ID cannot be null or empty."
        }

        $updateMap = @{
            "name" = $($Device.name)
            "policy_id" = $($Device.policy.id)
            "add_zone_ids" = $zoneIds
        }

        $json = $updateMap | ConvertTo-Json
        Write-Verbose "Update device JSON: $($json)"
        # remain silent
        $null = Invoke-CyRestMethod -API $API -Method PUT -Uri "$($API.BaseUrl)/devices/v2/$($Device.id)" -ContentType "application/json; charset=utf-8" -Body $json
    }
}

<#
.SYNOPSIS
    Removes device(s) from zone(s).
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Zone
    The zone to add the device to.
 
.PARAMETER Device
    The device(s) to add to the zone.
#>

function Remove-CyDeviceFromZone {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(
            Mandatory=$true, 
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true)]
            [object[]]$Device,
        [Parameter(Mandatory=$true)]
        [object]$Zone
    )

    Begin {
        $zoneIds = $Zone.id

        # zone IDs must be an array
        if ($zoneIds -isnot [array]) {
            $zoneIds = @($zoneIds)
        }
    }

    Process {
        $updateMap = @{
            "name" = $($Device.name)
            "policy_id" = $($Device.policy.id)
            "remove_zone_ids" = $zoneIds
        }

        $json = $updateMap | ConvertTo-Json
        # remain silent
        $null = Invoke-CyRestMethod -API $API -Method PUT -Uri "$($API.BaseUrl)/devices/v2/$($Device.id)" -ContentType "application/json; charset=utf-8" -Body $json
    }
}

<#
.SYNOPSIS
    Updates a zone.
 
.PARAMETER API
    Optional. API Handle (use only when not using session scope).
 
.PARAMETER Zone
    The zone to modify.
 
.PARAMETER Name
    Optional. Thenew name of the zone.
 
.PARAMETER Policy
    Optional. The new policy to set as the policy for the zone. NOTE, this does NOT affect the policy set on any device assigned to the zone! This is by principle and you'll have to look at the Cylance docs to better understand what this means.
 
.PARAMETER Criticality
    Optional. The new criticality to set for the zone.
#>

function Update-CyZone {
    Param (
        [parameter(Mandatory=$false)]
        [ValidateNotNullOrEmpty()]
        [CylanceAPIHandle]$API = $GlobalCyAPIHandle,
        [Parameter(Mandatory=$true)]
        [object]$Zone,
        [String]$Name = $null,
        [Parameter(Mandatory=$false)]
        [object]$Policy = @{ id = $null},
        [Parameter(Mandatory=$false)]
        [ValidateSet("Low", "Normal", "High")]
        [String]$Criticality
    )

    # default to existing
    $updateMap = @{
        name = $Zone.name
        policy_id = $Zone.policy_id
        criticality = $Zone.criticality
    }

    # update provided properties only
    if (![String]::IsNullOrEmpty($Name)) {
        $updateMap.name = $Name
    }
    if ($null -ne $Policy) {
        if (![String]::IsNullOrEmpty($Policy.id)) {
            $updateMap.policy_id = $Policy.id
        } else {
            $updateMap.policy_id = $Policy.policy_id
        }
    }
    if (![String]::IsNullOrEmpty($Criticality)) {
        $updateMap.criticality = $Criticality
    }

    $json = $updateMap | ConvertTo-Json
    Write-Verbose "Update zone JSON: $json"
    # remain silent
    $null = Invoke-CyRestMethod -API $API -Method PUT -Uri "$($API.BaseUrl)/zones/v2/$($Zone.id)" -ContentType "application/json; charset=utf-8" -Body $json
}