-
Notifications
You must be signed in to change notification settings - Fork 49
/
Get-GroupDetailsByFilter.ps1
146 lines (129 loc) · 5.36 KB
/
Get-GroupDetailsByFilter.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
<#
_author_ = Raajeev Kalyanaraman <[email protected]>
Copyright (c) 2022 Dell EMC Corporation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
#>
<#
.SYNOPSIS
Script to retrieve the details for a group including
all devices contained by that group
.DESCRIPTION
This script uses the OME REST API to get the details
for a group and for devices in that group. The group can
be filtered using the Group Name or Description.
This example uses ODATA queries with filter constructs.
Note that the credentials entered are not stored to disk.
.PARAMETER IpAddress
This is the IP address of the OME Appliance
.PARAMETER Credentials
Credentials used to talk to the OME Appliance
.PARAMETER FilterBy
Express filter criteria - name or description of group
.PARAMETER GroupInfo
The actual group name or description to search against
Note that this is a case sensitive search.
.EXAMPLE
$cred = Get-Credential
.\Get-GroupDetailsByFilter.ps1 -IpAddress "10.xx.xx.xx" -Credentials
$cred -FilterBy Description -GroupInfo "Dell iDRAC server devices"
.EXAMPLE
.\Get-GroupDetailsByFilter.ps1 -IpAddress "10.xx.xx.xx" -FilterBy
Name -GroupInfo "Dell iDRAC Servers"
In this instance you will be prompted for credentials to use to
connect to the appliance
#>
[CmdletBinding()]
param(
[Parameter(Mandatory)]
[System.Net.IPAddress] $IpAddress,
[Parameter(Mandatory)]
[pscredential] $Credentials,
[Parameter(Mandatory)]
[ValidateSet("Name", "Description")]
[String] $FilterBy,
[Parameter(Mandatory)]
[String] $GroupInfo
)
function Set-CertPolicy() {
## Trust all certs - for sample usage only
Try {
add-type @"
using System.Net;
using System.Security.Cryptography.X509Certificates;
public class TrustAllCertsPolicy : ICertificatePolicy {
public bool CheckValidationResult(
ServicePoint srvPoint, X509Certificate certificate,
WebRequest request, int certificateProblem) {
return true;
}
}
"@
[System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
}
catch {
Write-Error "Unable to add type for cert policy"
}
}
Try {
Set-CertPolicy
$SessionUrl = "https://$($IpAddress)/api/SessionService/Sessions"
$GroupUrl = "https://$($IpAddress)/api/GroupService/Groups?`$filter=$($FilterBy) eq '$($GroupInfo)'"
$Type = "application/json"
$UserName = $Credentials.username
$Password = $Credentials.GetNetworkCredential().password
$UserDetails = @{"UserName" = $UserName; "Password" = $Password; "SessionType" = "API" } | ConvertTo-Json
$Headers = @{}
$SessResponse = Invoke-WebRequest -Uri $SessionUrl -Method Post -Body $UserDetails -ContentType $Type
if ($SessResponse.StatusCode -eq 200 -or $SessResponse.StatusCode -eq 201) {
## Successfully created a session - extract the auth token from the response
## header and update our headers for subsequent requests
$Headers."X-Auth-Token" = $SessResponse.Headers["X-Auth-Token"]
$GrpResp = Invoke-WebRequest -Uri $GroupUrl -Method Get -Headers $Headers -ContentType $Type
if ($GrpResp.StatusCode -eq 200) {
$GrpInfo = $GrpResp.Content | ConvertFrom-Json
if ($GrpInfo.'@odata.count' -gt 0) {
## Only one group matching criteria should be found
$GroupId = $GrpInfo.value[0].Id
Write-Output "*** Group Details ***"
$GrpInfo.value | Format-List
$DevUrl = "https://$($IpAddress)/api/GroupService/Groups($($GroupId))/Devices"
$DevResp = Invoke-WebRequest -Uri $DevUrl -Method Get -Headers $Headers -ContentType $Type
if ($DevResp.StatusCode -eq 200) {
$DevInfo = $DevResp.Content | ConvertFrom-Json
if ($DevInfo.'@odata.count' -gt 0) {
Write-Output "*** Group Device Details ***"
$Devices = $DevResp.Content | ConvertFrom-Json
$Devices.'value' | Format-List
}
else {
Write-Warning "No devices found in group ($($GroupInfo))"
}
}
else {
Write-Warning "Unable to retrieve devices for group ($($GroupInfo)) from $($IpAddress)"
}
}
else {
Write-Warning "No group matching field ($($GroupInfo)) retrieved from $($IpAddress)"
}
}
else {
Write-Error "Unable to retrieve group list from $($IpAddress)"
}
}
else {
Write-Error "Unable to create a session with appliance $($IpAddress)"
}
}
catch {
Write-Error "Exception occured at line $($_.InvocationInfo.ScriptLineNumber) - $($_.Exception.Message)"
}