forked from andrebocchini/sccm-powershell-automation-module
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SCCM_Collection.psm1
1205 lines (993 loc) · 35 KB
/
SCCM_Collection.psm1
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<#
.SYNOPSIS
Adds a computer to a collection in SCCM.
.DESCRIPTION
Takes in information about a specific site, along with a computer resource ID, and a collection ID and creates a
direct membership rule for the computer in the specified collection.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER resourceId
Resource ID of the computer to be added to the collection.
.PARAMETER collectionId
ID of the collection where the computer is to be added.
#>
Function Add-SCCMComputerToCollection {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateScript( { $_ -gt 0 } )]
[int]
$resourceId,
[parameter(Mandatory=$true, Position=1)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$computer = Get-SCCMComputer -siteProvider $siteProvider -siteCode $siteCode -resourceId $resourceId
if(!$computer) {
Throw "Unable to retrieve computer with resource ID $resourceId"
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collection) {
Throw "Unable to retrieve collection with ID $collectionId"
}
# We want to get a list of all the collection this computer already belongs to so we can check later if it already is
# a member of the collection passed as a parameter to this function
$currentCollectionMembershipList = Get-SCCMCollectionsForComputer -siteProvider $siteProvider -siteCode $siteCode -resourceId $resourceId
$currentCollectionIdList = @()
foreach($currentCollectionMembership in $currentCollectionMembershipList) {
$currentCollectionIdList += ($currentCollectionMembership.CollectionID).ToUpper()
}
# We will only add the computer if it isn't already part of the collection passed as a parameter to this function
if($currentCollectionIdList -notcontains ($collection.CollectionID).ToUpper()) {
$collectionRule = New-SCCMCollectionRuleDirect -siteProvider $siteProvider -siteCode $siteCode -resourceId $resourceId
$addToCollectionParameters = $collection.GetmethodParameters("AddMembershipRule")
$addToCollectionParameters.CollectionRule = $collectionRule
$status = $collection.InvokeMethod("AddMembershipRule", $addToCollectionParameters, $null)
if($status.ReturnValue -ne 0) {
Throw "Failed to add computer $($computer.Name) to collection $($collection.Name)"
}
}
}
<#
.SYNOPSIS
Removes a computer from a specific collection
.DESCRIPTION
Takes in information about a specific site, along with a computer resource ID, and a collection ID and removes the computer from the collection.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER resourceId
Resource ID of the computer to be removed from the collection.
.PARAMETER collectionId
ID of the collection where the computer is a member.
#>
Function Remove-SCCMComputerFromCollection {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateScript( { $_ -gt 0 } )]
[int]
$resourceId,
[parameter(Mandatory=$true, Position=1)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$computer = Get-SCCMComputer -siteProvider $siteProvider -siteCode $siteCode -resourceId $resourceId
if(!$computer) {
Throw "Unable to retrieve computer with resource ID $resourceId"
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collection) {
Throw "Unable to retrieve collection with ID $collectionId"
}
$collectionRule = New-SCCMCollectionRuleDirect -siteProvider $siteProvider -siteCode $siteCode -resourceId $resourceId
$collectionRule.ResourceID = $resourceId
$status = $collection.DeleteMembershipRule($collectionRule)
if($status.ReturnValue -ne 0) {
Throw "Failed to remove computer $($computer.Name) from collection $($collection.Name)"
}
}
<#
.SYNOPSIS
Creates a direct collection rule.
.DESCRIPTION
Creates a direct collection rule.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER resourceId
Resource ID of the computer that is part of the rule.
.LINK
http://msdn.microsoft.com/en-us/library/cc145537.aspx
#>
Function New-SCCMCollectionRuleDirect {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateScript( { $_ -gt 0 } )]
[int]
$resourceId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$rule = ([WMIClass]("\\$siteProvider\root\sms\site_" + "$siteCode" + ":SMS_CollectionRuleDirect")).CreateInstance()
if($rule) {
$rule.ResourceClassName = "SMS_R_System"
$rule.ResourceID = $resourceId
}
return $rule
}
<#
.SYNOPSIS
Creates static SCCM collections
.DESCRIPTION
Allows the creation of static collections.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code where the collection is to be created.
.PARAMETER collectionName
The name of the new collection.
.PARAMETER parentCollectionId
If the static collection is not bound to a parent, it will not show up in the console. This parameter is mandatory and must be valid.
.PARAMETER collectionComment
Optional parameter. Attaches a comment to the collection.
.EXAMPLE
New-SCCMStaticCollection -siteProvider MYSITEPROVIDER -siteCode SIT -collectionName MYCOLLECTIONNAME -parentCollectionId SIT00012 -collectionComment "This is a comment"
#>
Function New-SCCMStaticCollection {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateNotNull()]
[string]
$collectionName,
[parameter(Mandatory=$true, Position=1)]
[ValidateLength(8,8)]
[string]
$parentCollectionId,
[string]
$collectionComment
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
if(Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $parentCollectionId) {
if(!(Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionName $collectionName)) {
$newCollection = ([WMIClass]("\\$siteProvider\root\sms\site_" + "$siteCode" + ":SMS_Collection")).CreateInstance()
$newCollection.Name = $collectionName
$newCollection.Comment = $collectionComment
$newCollection.OwnedByThisSite = $true
$newCollection.Put() | Out-Null
# Now we establish the parent to child relationship of the two collections. If we create a collection without
# establishing the relationship, the new collection will not be visible in the console.
$newCollectionId = (Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionName $collectionName).CollectionID
$newCollectionRelationship = ([WMIClass]("\\$siteProvider\root\sms\site_" + "$siteCode" + ":SMS_CollectToSubCollect")).CreateInstance()
$newCollectionRelationship.parentCollectionID = $parentCollectionId
$newCollectionRelationship.subCollectionID = $newCollectionId
$newCollectionRelationship.Put() | Out-Null
return Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $newCollectionId
} else {
Throw "A collection named $collectionName already exists"
}
} else {
Throw "Invalid parent collection"
}
}
<#
.SYNOPSIS
Returns a collection refresh schedule.
.DESCRIPTION
Returns a collection refresh schedule. If the collection is set to refresh manually, it returns null.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER collectionId
ID of the collection whose collection is being returned.
.LINK
http://msdn.microsoft.com/en-us/library/cc145320.aspx
#>
Function Get-SCCMCollectionRefreshSchedule {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId
)
Set-Variable refreshTypeManual -option Constant -value 1
Set-Variable refreshTypeAuto -option Constant -value 2
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if($collection) {
$collection.Get() | Out-Null
if($collection.RefreshType -eq $refreshTypeAuto) {
return $collection.RefreshSchedule
}
}
}
<#
.SYNOPSIS
Sets a collection refresh schedule.
.DESCRIPTION
Sets a collection refresh schedule.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER collectionId
ID of the collection whose collection whose schedule is being set.
.PARAMETER refreshType
Values allowed are 1 for manual refresh, and 2 for scheduled refresh. If 2 is specified, a schedule must
be passed as a parameter.
.PARAMETER refreshSchedule
A schedule token representing the collection refresh schedule.
.LINK
http://msdn.microsoft.com/en-us/library/cc145320.aspx
#>
Function Set-SCCMCollectionRefreshSchedule {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId,
[parameter(Mandatory=$true, Position=1)]
[ValidateRange(1,2)]
[int]
$refreshType = 1,
[parameter(Position=2)]
[ValidateScript( { !(!$_ -and $refreshType -eq 2) } )]
$refreshSchedule
)
Set-Variable refreshTypeManual -option Constant -value 1
Set-Variable refreshTypeAuto -option Constant -value 2
if($refreshType -eq $refreshTypeAuto) {
if(!($PSBoundParameters.refreshSchedule)) {
Throw "No refresh schedule specified"
}
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collection) {
Throw "Unable to retrieve collection with ID $collectionId"
} else {
$collection.Get() | Out-Null
}
$collection.RefreshType = $refreshType
if($refreshType -eq $refreshTypeAuto) {
$collection.RefreshSchedule = $refreshSchedule
}
$collection.Put() | Out-Null
}
<#
.SYNOPSIS
Saves a collection back into the SCCM database.
.DESCRIPTION
This function is used to save direct property changes to collections back to the SCCM database.
.PARAMETER collection
The collection object to be put back into the database.
#>
Function Save-SCCMCollection {
[CmdletBinding()]
param (
[parameter(Mandatory=$true)]
[ValidateNotNull()]
$collection
)
$collection.Put() | Out-Null
}
<#
.SYNOPSIS
Deletes SCCM collections
.DESCRIPTION
Takes in information about a specific site, along with a collection ID and deletes it.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code for the site to be queried.
.PARAMETER collectionId
The id of the collection to be deleted.
.EXAMPLE
Remove-SCCMCollection -siteProvider MYSITEPROVIDER -siteCode SIT -collectionId MYID
Description
-----------
Deletes the collection with id MYID from site SIT on MYSITEPROVIDER.
#>
Function Remove-SCCMCollection {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=1)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if($collection) {
$collection.Delete()
} else {
Throw "Unable to retrieve and delete collection with ID $collectionId"
}
}
<#
.SYNOPSIS
Retrieves SCCM collection objects from the specified site.
.DESCRIPTION
Takes in information about a specific site and a collection name and returns an object representing that collection. If no collection name is specified, it returns all collections found on the specified site.
.PARAMETER siteProvider
The name of the site.
.PARAMETER siteCode
The 3-character site code for the site where the collection exists.
.PARAMETER collectionName
Optional parameter. If specified, the function will try to find a collection that matches the name provided.
.PARAMETER collectionId
Optional parameter. If specified, the function will try to find a collection that matches the id provided.
.EXAMPLE
Get-SCCMCollection -siteProvider MYSITEPROVIDER -siteCode SIT -collectionName MYCOLLECTION
Description
-----------
Retrieve the collection named MYCOLLECTION from site SIT
.EXAMPLE
Get-SCCMCollection -siteProvider MYSITEPROVIDER -siteCode SIT
Description
-----------
Retrieve all collections from site SIT
.EXAMPLE
Get-SCCMCollection -siteProvider MYSITEPROVIDER -siteCode SIT | Select-Object Name,CollectionID
Description
-----------
Retrieve all collections from site SIT and filter out only their names and IDs
#>
Function Get-SCCMCollection {
[CmdletBinding(DefaultParametersetName="default")]
param (
[parameter(ParameterSetName="name")]
[parameter(ParameterSetName="default")]
[parameter(ParameterSetName="id")]
[string]
$siteProvider,
[parameter(ParameterSetName="name")]
[parameter(ParameterSetName="default")]
[parameter(ParameterSetName="id")]
[string]
$siteCode,
[parameter(ParameterSetName="name", Position=0, ValueFromPipeline=$true)]
[string]
$collectionName,
[parameter(ParameterSetName="id", Position=1)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
if($collectionId) {
return Get-WMIObject -Computer $siteProvider -Namespace "root\sms\site_$siteCode" -class SMS_Collection -filter "CollectionID='$collectionId'"
} elseif($collectionName) {
return Get-WMIObject -Computer $siteProvider -Namespace "root\sms\site_$siteCode" -Query "Select * from SMS_Collection WHERE Name like '$collectionName%'"
} else {
return Get-WMIObject -Computer $siteProvider -Namespace "root\sms\site_$siteCode" -Query "Select * from SMS_Collection"
}
}
<#
.SYNOPSIS
Retrieves the list of members of a collection.
.DESCRIPTION
Takes in information about an SCCM site along with a collection ID and returns a list of all members of the target collection.
.PARAMETER siteProvider
Name of the site provider.
.PARAMETER siteCode
Site code for the site containing the collection.
.PARAMETER collectionId
The ID of the collection whose members are being retrieved.
.EXAMPLE
Get-SCCMCollectionMembers -siteProvider MYSITEPROVIDER -siteCode SIT -collectionId SIT00012
.EXAMPLE
Get-SCCMCollectionMembers -siteProvider MYSITEPROVIDER -siteCode SIT -collectionId SIT00012 | Select-Object -ExpandProperty Name
Description
-----------
Retrieves all members of collection SIT00012 and lists only their names
#>
Function Get-SCCMCollectionMembers {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
return Get-WMIObject -Computer $siteProvider -Namespace "root\sms\site_$siteCode" -class "SMS_CollectionMember_a" -filter "CollectionID='$collectionId'"
}
<#
.SYNOPSIS
Returns a list of collection IDs that a computer belongs to.
.DESCRIPTION
Takes in information about a specific site, along with a computer resource ID and returns an array containing the collection IDs that the computer belongs to.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character code for the site where the computer exists.
.PARAMETER resourceId
Resource ID for the computer whose list of collections are being retrieved.
#>
Function Get-SCCMCollectionsForComputer {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateScript( { $_ -gt 0 } )]
[int]
$resourceId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
# First we find all membership associations that match the colection ID of the computer in question
$computer = Get-SCCMComputer -siteProvider $siteProvider -siteCode $siteCode -resourceId $resourceId
if(!$computer) {
Throw "Unable to retrieve computer with resource ID $resourceId"
}
$computerCollectionIds = @()
$collectionMembers = Get-WMIObject -Computer $siteProvider -Namespace "root\sms\site_$siteCode" -Query "Select * From SMS_CollectionMember_a Where ResourceID= $($computer.ResourceID)"
foreach($collectionMember in $collectionMembers) {
$computerCollectionIds += $collectionMember.CollectionID
}
# Now that we have a list of collection IDs, we want to retrieve and return some rich collection objects
if ($psversiontable.psversion.major -le 3){
$collectionId = $collectionName = $null # It may be set in a parent scope. Not needed in PS >= 3.0
}
$allServerCollections = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode
$computerCollections = @()
foreach($collectionId in $computerCollectionIds) {
foreach($collection in $allServerCollections) {
if($collection.CollectionID -eq $collectionId) {
$computerCollections += $collection
}
}
}
return $computerCollections
}
<#
.SYNOPSIS
Retrieves collection settings.
.DESCRIPTION
Retrieves collection settings.
.PARAMETER siteProvider
Name of the site provider.
.PARAMETER siteCode
3-character site code.
.PARAMETER resourceId
The ID of the collection whose settings are to be retrieved.
.LINK
http://msdn.microsoft.com/en-us/library/cc145320.aspx
#>
Function Get-SCCMCollectionSettings {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, ValueFromPipeline=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collectionSettings = Get-WMIObject -ComputerName $siteProvider -Namespace "root\sms\site_$siteCode" -Class "SMS_CollectionSettings" -filter "CollectionID='$collectionId'"
if($collectionSettings) {
$collectionSettings.Get() | Out-Null
}
return $collectionSettings
}
<#
.SYNOPSIS
Creates collection settings objects.
.DESCRIPTION
Creates collection settings objects.
.PARAMETER siteProvider
Name of the site provider.
.PARAMETER siteCode
3-character site code.
.PARAMETER resourceId
The ID of the collection for which settings are to be created.
.LINK
http://msdn.microsoft.com/en-us/library/cc145320.aspx
#>
Function New-SCCMCollectionSettings {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, ValueFromPipeline=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collection) {
Throw "Unable to retrive collection with ID $collectionId"
}
$collectionSettings = ([WMIClass]("\\$siteProvider\root\sms\site_" + "$siteCode" + ":SMS_CollectionSettings")).CreateInstance()
if($collectionSettings) {
$collectionSettings.CollectionID = $collection.CollectionID
}
return $collectionSettings
}
<#
.SYNOPSIS
Sets variables on an SCCM collection.
.DESCRIPTION
Takes in information about a specific site, along with a collection ID and an array of variables, and assigns those variables to the collection.
.PARAMETER siteProvider
Name of the site provider.
.PARAMETER siteCode
3-character site code.
.PARAMETER resourceId
ID of the target collection.
.PARAMETER variableList
An array of variables to be assigned to the collection. If you pass it an empty array, it will clear all variables on the collection.
.LINK
http://msdn.microsoft.com/en-us/library/cc145320.aspx
#>
Function Set-SCCMCollectionVariables {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, ValueFromPipeline=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId,
[parameter(Mandatory=$true, Position=1)]
[ValidateNotNull()]
$variableList
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collection) {
Throw "Unable to retrieve collection with ID $collectionId"
}
$collectionSettings = Get-SCCMCollectionSettings -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collectionSettings) {
$collectionSettings = New-SCCMCollectionSettings -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
}
$collectionSettings.CollectionVariables = $variableList
Save-SCCMCollectionSettings $collectionSettings
}
<#
.SYNOPSIS
Returns an array of all collection variables for a specific collection.
.DESCRIPTION
Returns an array of all collection variables for a specific collection.
.PARAMETER siteProvider
Name of the site provider.
.PARAMETER siteCode
3-character site code.
.PARAMETER collectionId
ID of the target collection.
.LINK
http://msdn.microsoft.com/en-us/library/cc146201.aspx
#>
Function Get-SCCMCollectionVariables {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, ValueFromPipeline=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collection = Get-SCCMCollection -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if(!$collection) {
Throw "Unable to retrieve collection with ID $collectionId"
}
$collectionSettings = Get-SCCMCollectionSettings -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if($collectionSettings) {
return $collectionSettings.CollectionVariables
}
}
<#
.SYNOPSIS
Creates a new comllection variable.
.DESCRIPTION
Creates a new collection variable.
.PARAMETER siteProvider
Name of the site provider.
.PARAMETER siteCode
3-character site code.
.PARAMETER variableName
Name of the variable to be created.
.PARAMETER variableValue
Value to be assigned to the variable.
.PARAMETER isMasked
A masked variable has its text display replaced with asterisks.
.LINK
http://msdn.microsoft.com/en-us/library/cc146201.aspx
#>
Function New-SCCMCollectionVariable {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateNotNull()]
[string]
$variableName,
[parameter(Mandatory=$true, Position=0)]
[ValidateNotNull()]
[string]
$variableValue,
[parameter(Mandatory=$true, Position=0)]
[bool]
$isMasked
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collectionVariable = ([WMIClass]("\\$siteProvider\root\sms\site_" + "$siteCode" + ":SMS_CollectionVariable")).CreateInstance()
if($collectionVariable) {
$collectionVariable.IsMasked = $isMasked
$collectionVariable.Name = $variableName
$collectionVariable.Value = $variableValue
}
return $collectionVariable
}
<#
.SYNOPSIS
Saves an object containing a collection's machine settings back into the database.
.DESCRIPTION
Saves an object containing a collection's machine settings back into the database.
.PARAMETER collectionSettings
The object to be saved back into the database.
.LINK
http://msdn.microsoft.com/en-us/library/cc145320.aspx
#>
Function Save-SCCMCollectionSettings {
[CmdletBinding()]
param (
[parameter(Mandatory=$true)]
[ValidateNotNull()]
$collectionSettings
)
$collectionSettings.Put() | Out-Null
}
<#
.SYNOPSIS
Returns the maintenance windows for a collection.
.DESCRIPTION
Returns the maintenance windows for a collection.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER collectionId
ID of the collection whose maintenance windows are being retrieved.
.LINK
http://msdn.microsoft.com/en-us/library/cc143300.aspx
#>
Function Get-SCCMMaintenanceWindows {
[CmdletBinding()]
param (
[string]
$siteProvider,
[string]
$siteCode,
[parameter(Mandatory=$true, Position=0)]
[ValidateLength(8,8)]
[string]
$collectionId
)
if(!($PSBoundParameters) -or !($PSBoundParameters.siteProvider)) {
$siteProvider = Get-SCCMSiteProvider
}
if(!($PSBoundParameters) -or !($PSBoundParameters.siteCode)) {
$siteCode = Get-SCCMSiteCode
}
$collectionSettings = Get-SCCMCollectionSettings -siteProvider $siteProvider -siteCode $siteCode -collectionId $collectionId
if($collectionSettings) {
$collectionSettings.Get()
return $collectionSettings.ServiceWindows
}
}
<#
.SYNOPSIS
Retrieves the schedules from a maintenance window object.
.DESCRIPTION
Retrieves the schedules from a maintenance window object.
.PARAMETER siteProvider
The name of the site provider.
.PARAMETER siteCode
The 3-character site code.
.PARAMETER maintenanceWindow