forked from jonnyt/posh-itop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itop.psm1
2362 lines (1889 loc) · 74 KB
/
itop.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
<#
Requires MySql libraries to be imported first when using the Data Synchro functions, see posh-mysql
#>
Function Get-iTopVirtualDeviceVolume {
<#
.Synopsis
Get volume information for a virtual device (Virtualmachine, Hypervisor, Farm)
.Description
Get volume information for a virtual device (Virtualmachine, Hypervisor, Farm)
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-iTopVirtualDeviceVolume -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-iTopVirtualDeviceVolume -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = 'MySQL'"
#>
[CmdletBinding(DefaultParameterSetName='All')]
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(ParameterSetName='name',Mandatory=$False)][string]$virtualDeviceName,
[Parameter(ParameterSetName='id',Mandatory=$False)][string]$virtualDeviceID,
[Parameter(ParameterSetName='oql',Mandatory=$False)][string]$oqlFilter,
[Parameter(ParameterSetName='oql',Mandatory=$False)][string]$outputFields='*'
)
switch($PSCmdlet.ParameterSetName)
{
'name'{Get-iTopObject -objectClass 'lnkVirtualDeviceToVolume' -oqlFilter "WHERE virtualdevice_name = '$virtualDeviceName'" -ouputFields $outputFields -uri $uri -credentials $credentials}
'id' {Get-iTopObject -objectClass 'lnkVirtualDeviceToVolume' -oqlFilter "WHERE virtualdevice_id = '$virtualDeviceID'" -ouputFields $outputFields -uri $uri -credentials $credentials}
'oql' {Get-iTopObject -objectClass 'lnkVirtualDeviceToVolume' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials}
default {Get-iTopObject -objectClass 'lnkVirtualDeviceToVolume' -uri $uri -credentials $credentials}
}
}
Function Get-Software {
<#
.Synopsis
Find software
.Description
Find software
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = 'MySQL'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Write-Warning ("Function name {0} is deprecated. Use {1} instead." -f $MyInvocation.MyCommand,"$($MyInvocation.MyCommand.Name -replace '-','-iTop')")
Get-iTopObject -objectClass 'Software' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
New-Alias -Name Get-iTopSoftware -Value Get-Software -Force
Function Get-iTopGlobalIPSetting {
<#
.Synopsis
Find Global IP Settings (IPConfig)
.Description
Find global IP settings
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = 'MySQL'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'IPConfig' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-iTopDomain {
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Domain' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-iTopIPUsage {
<#
.Synopsis
Find Global IP Settings (IPConfig)
.Description
Find global IP settings
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = 'MySQL'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'IPUsage' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-iTopLocation {
<#
.Synopsis
Find software
.Description
Find software
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Software -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = 'MySQL'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Location' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-SynchroDataSource {
<#
.Synopsis
Find a synchronization data source
.Description
Find a synchronization data source
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-SynchroDataSource -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-SynchroDataSource -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'DEV VMware Source'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Write-Warning ("Function name {0} is deprecated. Use {1} instead." -f $MyInvocation.MyCommand,"$($MyInvocation.MyCommand.Name -replace '-','-iTop')")
Get-iTopObject -objectClass 'SynchroDataSource' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
New-Alias -Name Get-iTopSynchroDataSource -Value Get-SynchroDataSource -Force
Function Get-FunctionalCI {
<#
.Synopsis
Get a functional CI
.Description
Get a functional CI
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-FunctionalCI -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-FunctionalCI -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'DEV VMware Source'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Write-Warning ("Function name {0} is deprecated. Use {1} instead." -f $MyInvocation.MyCommand,"Get-iTopCI")
Get-iTopObject -objectClass 'FunctionalCI' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
New-Alias -Name Get-iTopCI -Value Get-FunctionalCI -Force
Function Get-Enclosure {
<#
.Synopsis
Get an enclosure or collection of enclosures
.Description
Get an enclosure or collection of enclosures
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Enclosure -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Enclosure -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.serialnumber -eq 'abc123'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Enclosure' -ouputFields '*' -uri $uri -credentials $credentials -oqlFilter $oqlFilter
}
Function Get-Rack {
<#
.Synopsis
Get rack or collection of racks
.Description
Get rack or collection of racks
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Rack -credentials (Get-Credential) -uri 'https://webservice.edu'
.Example
Get-Rack -credentials (Get-Credential) -uri 'https://webservice.edu' -oqlFilter "WHERE name = 'F15'"
.Example
Get-Rack -credentials (Get-Credential) -uri 'https://webservice.edu' -oqlFilter "WHERE nb_u > 20"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Rack' -ouputFields '*' -uri $uri -credentials $credentials -oqlFilter $oqlFilter
}
Function Get-StorageSystem {
<#
.Synopsis
Get an enclosure or collection of storage systems
.Description
Get an enclosure or collection of storage systems
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-StorageSystem -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-StorageSystem -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.name -eq 'abc123'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'StorageSystem' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-iTopLogicalInterface {
<#
.Synopsis
Get an logial interface or collection of logical interfaces
.Description
Get an logial interface or collection of logical interfaces
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-iTopLogicalInterface -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-iTopLogicalInterface -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.macaddress -eq '00:00:00:00:00:00'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'LogicalInterface' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-LogicalVolume {
<#
.Synopsis
Get an enclosure or collection of logical volumes
.Description
Get an enclosure or collection of logical volumes
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-LogicalVolume -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-LogicalVolume -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.name -eq 'abc123'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'LogicalVolume' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
Function Get-Brand {
<#
.Synopsis
Get a brand typology or collection of brands
.Description
Get a brand typology or collection of brands
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Brand -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Brand -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'HP Inc.'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Brand' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
Function Get-ContactType {
<#
.Synopsis
Get a contact type typology or collection of brands
.Description
Get a contact type typology or collection of brands
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-ContactType -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-ContactType -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'Functional Owner'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'ContactType' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
New-Alias -Name Get-iTopContactType -Value Get-ContactType -Force
New-Alias -Name Get-iTopRole -Value Get-ContactType -Force
Function Get-ContractType {
<#
.Synopsis
Get a contract typology or collection of contract types
.Description
Get a contract typology or collection of contract types
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-ContractType -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-ContractType -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'Blade'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'ContractType' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
Function Get-Model {
<#
.Synopsis
Get a model typology or collection of brands
.Description
Get a model typology or collection of brands
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-Model -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Model -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'R720'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Model' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
Function Get-OSVersion {
<#
.Synopsis
Get an OS Version typology or collection of OS Versions
.Description
Get an OS Version typology or collection of OS Versions
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-OSVersion -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-OSVersion -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -like 'Service Pack*'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri
)
Get-iTopObject -objectClass 'OSVersion' -ouputFields '*' -uri $uri -credentials $credentials
}
Function Get-OSFamily {
<#
.Synopsis
Get an OS Family typology or collection of OS Families
.Description
Get an OS Family typology or collection of OS Families
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-OSFamily -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-OSFamily -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -like 'Microsoft*'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri
)
Get-iTopObject -objectClass 'OSFamily' -ouputFields '*' -uri $uri -credentials $credentials
}
Function Get-Server {
<#
.Synopsis
Get a server collection of servers
.Description
Get a server collection of servers
.Parameter name
Optional, otherwise returns collection
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Model -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Model -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.serialnumber -eq 'H1SMQ3'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Server' -oqlFilter $oqlFilter -ouputFields $outputFields -uri $uri -credentials $credentials
}
Function Get-VirtualFarm {
<#
.Synopsis
Find a virtual farm / cluster
.Description
Find a virtual farm / cluster
.Parameter name
The name of the farm / cluster
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-VirtualFarm -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'Cluster 1'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Farm' -ouputFields $outputFields -oqlFilter $oqlFilter -uri $uri -credentials $credentials
}
Function Get-Hypervisor {
<#
.Synopsis
Get a hypervisor or collection of hypervisors
.Description
Get a hypervisor or collection of hypervisors
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-Hypervisor -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = `'esxServer01`'" -outputFields 'name,id'
.Example
Get-Hypervisor -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'Server 1'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Hypervisor' -ouputFields $outputFields -uri $uri -credentials $credentials -oqlFilter $oqlFilter
}
Function Get-DBServer {
<#
.Synopsis
Get a dbserver or collection of dbservers
.Description
Get a dbserver or collection of dbservers
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-DBServer -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' -oqlFilter "WHERE name = `'mySqlServer01`'" -outputFields 'name,id'
.Example
Get-DBServer -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'mySqlServer01'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'DBServer' -ouputFields $outputFields -uri $uri -credentials $credentials -oqlFilter $oqlFilter
}
Function Get-Organization {
<#
.Synopsis
Get all organizations
.Description
Get all organizations
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-Organization -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Organization -authName 'user' -authPwd 'password' -uri 'https://webservice.edu' | Where {$_.Name -eq 'UC Berkeley'}
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Organization' -ouputFields '*' -uri $uri -credentials $credentials -oqlFilter $oqlFilter
}
Function Get-Contact {
<#
.Synopsis
Get a contact or collection of contacts
.Description
Get a contact or collection of contacts including people and teams
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-Person -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Person -employeeNumber 123456 -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Contact' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-Team {
<#
.Synopsis
Get a team or collection of teams
.Description
Get a team or collection of teams
.Parameter authName
Logon for the iTop web service
.Parameter authPwd
Password for the iTop web service
.Parameter uri
uri for the iTop web service
.Example
Get-Team -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Team' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-iTopGroup {
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Group' -ouputFields $outputFields -uri $uri -credentials $credentials -oqlFilter $oqlFilter
}
Function Get-iTopIPv4Address {
<#
.Synopsis
Get a IPv4 address or collection of addresses
.Description
Get a IPv4 address or collection of addresses
.Parameter uri
uri for the iTop web service
.Example
Get-iTopIPv4Address -credentials $cred -uri 'https://webservice.edu'
.Example
Get-iTopIPv4Address -credentials $cred -uri 'https://webservice.edu' -oqlFilter "WHERE status='Allocated'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'IPv4Address' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-iTopIPv4Block {
<#
.Synopsis
Get a IPv4 block or collection of blocks
.Description
Get a IPv4 block or collection of blocks
.Parameter uri
uri for the iTop web service
.Example
Get-iTopIPv4Block -credentials $cred -uri 'https://webservice.edu'
.Example
Get-iTopIPv4Block -credentials $cred -uri 'https://webservice.edu' -oqlFilter "WHERE status='Allocated'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'IPv4Block' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-iTopIPv4Subnet {
<#
.Synopsis
Get a IPv4 subnets or collection of subnets
.Description
Get a IPv4 subnets or collection of subnets
.Parameter uri
uri for the iTop web service
.Example
Get-iTopIPv4Subnet -credentials $cred -uri 'https://webservice.edu'
.Example
Get-iTopIPv4Subnet -credentials $cred -uri 'https://webservice.edu' -oqlFilter "WHERE ip='127.0.0.0'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'IPv4Subnet' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-iTopVlan {
<#
.Synopsis
Get a VLAN or collection of VLANS
.Description
Get a VLAN subnets or collection of VLANS
.Parameter uri
uri for the iTop web service
.Example
Get-iTopVlan -credentials $cred -uri 'https://webservice.edu'
.Example
Get-iTopVlan -credentials $cred -uri 'https://webservice.edu' -oqlFilter "WHERE vlan_tag='4012'"
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'VLAN' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-Person {
<#
.Synopsis
Get a person or collection of people
.Description
Get a person or collection of people
.Parameter employeeNumber
Employee number, currently same as UID
.Parameter credentials
PSCredential used for authentication
.Parameter uri
uri for the iTop web service
.Example
Get-Person -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
.Example
Get-Person -employeeNumber 123456 -authName 'user' -authPwd 'password' -uri 'https://webservice.edu'
#>
Param(
[Parameter(Mandatory=$True)][PSCredential]$credentials,
[Parameter(Mandatory=$True)][string]$uri,
[Parameter(Mandatory=$False)][string]$oqlFilter,
[Parameter(Mandatory=$False)][string]$outputFields='*'
)
Get-iTopObject -objectClass 'Person' -uri $uri -credentials $credentials -oqlFilter $oqlFilter -ouputFields $outputFields
}
Function Get-CustomerContract {
<#
.Synopsis
Get a customer contract or collection of contracts