-
Notifications
You must be signed in to change notification settings - Fork 0
/
ActPowerCLI.psm1
1757 lines (1564 loc) · 54.7 KB
/
ActPowerCLI.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
# Copyright 2022 Google Inc. All Rights Reserved.
#
# 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.
# # Version number of this module.
# ModuleVersion = '10.0.1.40'
function psfivecerthandler
{
if (-not ([System.Management.Automation.PSTypeName]'ServerCertificateValidationCallback').Type)
{
$certCallback = @"
using System;
using System.Net;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
public class ServerCertificateValidationCallback
{
public static void Ignore()
{
if(ServicePointManager.ServerCertificateValidationCallback ==null)
{
ServicePointManager.ServerCertificateValidationCallback +=
delegate
(
Object obj,
X509Certificate certificate,
X509Chain chain,
SslPolicyErrors errors
)
{
return true;
};
}
}
}
"@
Add-Type $certCallback
}
[ServerCertificateValidationCallback]::Ignore()
# ensure TLS12 is in use. We set it back when disconnect-act is run
$env:CUR_PROTS = [System.Net.ServicePointManager]::SecurityProtocol
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12;
}
function Connect-Act([string]$acthost, [string]$actuser, [string]$password, [string]$passwordfile, [switch][alias("q")]$quiet,[switch][alias("p")]$printsession,[switch][alias("i")]$ignorecerts,[switch][alias("s")]$sortoverride,[switch][alias("f")]$sortoverfile,[int]$actmaxapilimit,[int]$timeout)
{
<#
.SYNOPSIS
Login to a VDP appliance.
.EXAMPLE
connect-act -acthost 10.65.5.35 -actuser admin -passwordfile pass.key
Using a password file to login. Path to password file can be absolute or relative path.
.EXAMPLE
connect-act -acthost 10.65.5.35 -actuser admin -password Password123
Example using the password on the command line itself to login.
.EXAMPLE
connect-act 10.65.5.35 admin -ignorecerts
Example where certificate checking is disabled.
.DESCRIPTION
Connect to VDP Appliance using a username and password or by specifying -passwordfile
which will use stored credentials.
If no password is provided and no passwordfile flag is set, then the function will
prompt for a password
Using -quiet suppresses all successful messages
SSL Certificate checking is performed during Connect-Act
To always accept and skip the check use -ignorecerts
.PARAMETER acthost
Required. Hostname or IP to connect to.
.PARAMETER actuser
Required. Username to connect to VDP as. Same username that is used in the
Actifio Appliance Setup panel.
.PARAMETER password
Optional. If not provided, a prompt will be presented. If provided, it can be provided
as clear text.
example: connect-act -acthost 10.65.5.35 -actuser admin -password Password123
.PARAMETER passwordfile
Optional. This is a string that instructs Connect-Act to use stored credentials as
opposed to interactive login. In order to use -passwordfile, you must use
save-actpassword first to save the password.
example: connect-act -acthost 10.65.5.35 -actuser admin -passwordfile pass.key
example: connect-act 10.65.5.35 admin -passwordfile .\pass.key
example: connect-act 10.65.5.35 admin -passwordfile pass.key
The password file can be a relative path or a fully qualified path to the file
.PARAMETER quiet
Optional. Suppresses all success messages. Use this in scripting when you
don't want to see a successful login message. To validate the connection, check
for variable $env:ACTSESSIONID
#>
# max objects returned will be unlimited. Otherwise user can supply a limit
if ((!($actmaxapilimit)) -and ($env:actmaxapilimit -eq $null))
{
$env:actmaxapilimit = 0
}
if ($timeout)
{
$env:acttimeout = $timeout
}
if ((!($timeout)) -and ($env:acttimeout -eq $null))
{
$env:acttimeout = 15
}
if (!($acthost))
{
$acthost = Read-Host "IP or Name of VDP"
}
# if user didnt tell us at start to ignore cert, we need to test it
if (!($ignorecerts))
{
Try
{
$resp = Invoke-RestMethod -Uri https://$acthost/actifio/api/version -TimeoutSec $env:acttimeout
}
Catch
{
$RestError = $_
}
if (($RestError -like "*was canceled*") -or ($RestError -like "*The operation has timed out*"))
{
Get-ActErrorMessage -messagetoprint "No response was received from $acthost after $env:acttimeout seconds"
return;
}
elseif (($RestError -like "Connection refused") -or ($RestError -like "Unable to connect to the remote server"))
{
Get-ActErrorMessage -messagetoprint "Connection refused received from $acthost"
return;
}
elseif ($RestError -like "{*")
{
$loginfailure = Test-ActJSON $RestError
if ( ($loginfailure.err_code) -and (!($loginfailure.errormessage)) )
{
Get-ActErrorMessage -messagetoprint "Login failed. You may be trying to login to an AGM"
}
else
{
$loginfailure
}
}
elseif ($RestError)
{
Write-Host -ForeGroundColor Yellow "The SSL certificate from https://$acthost is not trusted. Please choose one of the following options";
Write-Host -ForeGroundColor Yellow "(I)gnore & continue";
Write-Host -ForeGroundColor Yellow "(C)ancel";
$validresp = ("i", "I", "c", "C");
$certaction = $null
# prompt until we get a proper response.
while ( $validresp.Contains($certaction) -eq $false )
{
$certaction = Read-Host "Please select an option";
}
# based on the action, do the right thing.
if ( $certaction -eq "i" -or $certaction -eq "I" )
{
$hostVersionInfo = (get-host).Version.Major
if ( $hostVersionInfo -lt "6" )
{
psfivecerthandler
}
else
{
# set IGNOREACTCERTS so that we ignore self-signed certs
$env:IGNOREACTCERTS = "y"
}
}
elseif ( $certaction -eq "c" -or $certaction -eq "C" )
{
# just exit
break;
}
}
}
else
{
$hostVersionInfo = (get-host).Version.Major
if ( $hostVersionInfo -lt "6" )
{
psfivecerthandler
}
else
{
$env:IGNOREACTCERTS = "y"
}
}
# we need a user name
if (!($actuser))
{
$vdpuser = Read-Host "VDP user"
}
else
{
$vdpuser = $actuser
}
if (!($passwordfile))
{
if (!($password))
{
# prompt for a password
[SecureString]$passwordenc = Read-Host -AsSecureString "Password";
}
else
{
[SecureString]$passwordenc = (ConvertTo-SecureString $password -AsPlainText -Force)
}
}
else
{
# if the password file provided is relative or absolute doesn't matter. Test for it first
if ( Test-Path $passwordfile )
{
[SecureString]$passwordenc = Get-Content $passwordfile | ConvertTo-SecureString;
}
else
{
Get-ActErrorMessage -messagetoprint "Password file: $passwordfile could not be opened."
return;
}
}
# build a vendorkey
$moduledetails = Get-Module ActPowerCLI
$platform=$PSVersionTable.platform
if (!($platform)) { $platform = 'Win32NT'}
$vendorkey = "ActPowerCLI-" + $moduledetails.version.ToString() + "_" + $platform + "-PSVersion" + $hostVersionInfo
# password needs to be sent as base64 per API Guide
$UnsecurePassword = [System.Net.NetworkCredential]::new("", $passwordenc).Password
# URL encode the password to handle password with # in it
$encodedpassword = [System.Net.WebUtility]::UrlEncode($UnsecurePassword)
# $UnsecurePassword = ConvertFrom-SecureString -SecureString $passwordenc -AsPlainText
# $Header = @{"Authorization" = "Basic "+[System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes($vdpuser+":"+$UnsecurePassword))}
$Url = "https://$acthost/actifio/api/login?name=$vdpuser&password=$encodedpassword&vendorkey=$vendorkey"
$RestError = $null
Try
{
if ( ($env:IGNOREACTCERTS -eq "y") -and ($((get-host).Version.Major) -gt 5) )
{
$resp = Invoke-RestMethod -SkipCertificateCheck -Method POST -Uri $Url -TimeoutSec $env:acttimeout
}
else
{
$resp = Invoke-RestMethod -Method POST -Uri $Url -TimeoutSec $env:acttimeout
}
}
Catch
{
$RestError = $_
}
if (($RestError -like "*was canceled*") -or ($RestError -like "*The operation has timed out*"))
{
Get-ActErrorMessage -messagetoprint "No response was received from $acthost after $env:acttimeout seconds"
return;
}
elseif (($RestError -like "Connection refused") -or ($RestError -like "Unable to connect to the remote server"))
{
Get-ActErrorMessage -messagetoprint "Connection refused received from $acthost"
return;
}
elseif ($RestError -like "{*")
{
$loginfailure = Test-ActJSON $RestError
if ( ($loginfailure.err_code) -and (!($loginfailure.errormessage)) )
{
Get-ActErrorMessage -messagetoprint "Login failed. You may be trying to login to an AGM"
}
else
{
$loginfailure
}
}
elseif ($RestError)
{
Get-ActErrorMessage -messagetoprint "$RestError"
}
else
{
$global:ACTPRIVILEGES = $resp.rights
$env:ACTPRIVILEGES = $resp.rights
$env:ACTSESSIONID = $resp.sessionid
$env:acthost = $acthost
if ($printsession)
{
Write-Host "$env:ACTSESSIONID"
}
elseif (!($quiet))
{
Write-Host "Login Successful!"
}
# since login was successful, lets create some environment variables about the Appliance we connected to
Try
{
if ( ($env:IGNOREACTCERTS -eq "y") -and ($((get-host).Version.Major) -gt 5) )
{
$resp = Invoke-RestMethod -SkipCertificateCheck -Uri https://$acthost/actifio/api/fullversion
}
else
{
$resp = Invoke-RestMethod -Uri https://$acthost/actifio/api/fullversion
}
}
Catch
{
$RestError = $_
}
if ($RestError)
{
Test-ActJSON $RestError
}
else
{
if ($resp.result)
{
$env:ACTPLATFORM = $resp.result.platform.SubString(0,3)
}
else
{
$env:ACTPLATFORM = "UNKNOWN"
}
if ($resp.result.version)
{
$env:ACTVERSION = $resp.result.version
}
else
{
$env:ACTVERSION = "0.0.0.0"
}
}
# if user issued -s they can override sort fetching
if ($sortoverride)
{
$env:ACTSORTOVERRIDE = "y"
$global:ACTSORTORDER = ""
}
elseif ($sortoverfile)
{
$env:ACTSORTOVERRIDE = "f"
}
else
{
$env:ACTSORTOVERRIDE = "n"
}
# now we create functions for SARG
New-SARGFuncs
# finally we do command completion for uds commands
$env:UDSINFOCMDS = (udsinfo -h).name
$env:UDSTASKCMDS = (udstask -h).name
$udsinfoSubCommandCompletion = {
param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
if ( $wordToComplete -eq "" )
{
$ENV:UDSINFOCMDS -split " "
}
else
{
$ENV:UDSINFOCMDS -split " " -match "^$wordToComplete"
}
}
$udstaskSubCommandCompletion = {
param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
if ( $wordToComplete -eq "" )
{
$ENV:UDSTASKCMDS -split " "
}
else
{
$ENV:UDSTASKCMDS -split " " -match "^$wordToComplete"
}
}
Register-ArgumentCompleter -CommandName udsinfo -Parameter subcommand -ScriptBlock $udsinfoSubCommandCompletion
Register-ArgumentCompleter -CommandName udstask -Parameter subcommand -ScriptBlock $udstaskSubCommandCompletion
}
}
# this function disconnects from the VDP Appliance
function Disconnect-Act([switch][alias("q")]$quiet)
{
<#
.SYNOPSIS
Disconnect and end the session with the VDP Appliance.
.EXAMPLE
Disconnect-Act
.DESCRIPTION
Disconnect from the VDP appliance and end the session nicely.
#>
if ( (!($env:ACTSESSIONID)) -or (!($env:acthost)) )
{
Get-ActErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-Act"
return;
}
# disconnect
$Url = "https://$env:acthost/actifio/api/logout" + "?&sessionid=$env:ACTSESSIONID"
$RestError = $null
Try
{
if ( ($env:IGNOREACTCERTS -eq "y") -and ($((get-host).Version.Major) -gt 5) )
{
$null = Invoke-RestMethod -SkipCertificateCheck -Method POST -Uri $Url -TimeoutSec $env:acttimeout
}
else
{
$null = Invoke-RestMethod -Method POST -Uri $Url -TimeoutSec $env:acttimeout
}
}
Catch
{
$RestError = $_
}
if ($RestError)
{
Test-ActJSON $RestError
}
else
{
if ($quiet)
{
return
}
else
{
Write-Host "Success!"
}
}
$env:acthost = $null
$env:ACTVERSION = $null
$env:ACTPLATFORM = $null
$env:ACTSESSIONID = $null
$env:ACTPRIVILEGES = $null
$env:ACTSORTOVERRIDE = $null
$env:actmaxapilimit = $null
$env:IGNOREACTCERTS = $null
$env:UDSINFOCMDS = $null
$env:UDSTASKCMDS = $null
$env:acttimeout = $null
$global:ACTSORTORDER = $null
$global:ACTPRIVILEGES = $null
# Set the security protocol back to the old defaults
if ($env:CUR_PROTS)
{
[Net.ServicePointManager]::SecurityProtocol = $env:CUR_PROTS
$env:CUR_PROTS = $null
}
}
# internal function to pull SARG sort order
function Get-SARGSortOrder([string]$parmletter,[string]$reportname)
{
if ($env:ACTPLATFORM -eq "CDS")
{
$ACTSORTORDER | where-object {$_.option -eq $parmletter -and $_.reportname -eq $reportname -and $_.CDS -eq "Y"} | select-object SortOrder
}
elseif ($env:ACTPLATFORM -eq "Sky")
{
$ACTSORTORDER | where-object {$_.option -eq $parmletter -and $_.reportname -eq $reportname -and $_.VDP -eq "Y"} | select-object SortOrder
}
elseif ($env:ACTPLATFORM -eq "CDX")
{
$ACTSORTORDER | where-object {$_.option -eq $parmletter -and $_.reportname -eq $reportname -and $_.CDX -eq "Y"} | select-object SortOrder
}
else
{
$ACTSORTORDER | where-object {$_.option -eq $parmletter -and $_.reportname -eq $reportname -and $_.VDP -eq "Y"} | select-object SortOrder
}
}
# Get-InternalSARGReport function
function Get-InternalSARGReport([string]$reportname,[string]$sargparms,[switch][alias("h")]$help)
{
<#
.SYNOPSIS
Executes SARG commands via a rest API hosted on a VDP Appliance. Do not run it manually.
.DESCRIPTION
Internal function used to fetch data
#>
# make sure we have something to connect to
if ( (!($env:ACTSESSIONID)) -or (!($env:acthost)) )
{
Get-ActErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-Act"
return;
}
if ( (!($reportname)) -and ($help))
{
$reportname = "reportlist"
}
if (!($reportname))
{
Get-ActErrorMessage -messagetoprint "No reportname was provided. Please provide a reportname."
return;
}
if ($sargparms)
{
# we are going to send all the SARG command opts in REST format as sargopts
$sargopts = $null
$sargreportsortorder = $null
$sargsortordertest = $null
$trimm = $null
# we will split on dashes. This means if there are dashes in a search object, this will break the process. We dump blank lines
$sargparms = " " + "$sargparms"
$dashsep = $sargparms -split " -" -notmatch '^\s*$'
foreach ($line in $dashsep)
{
# remove any whitespace at the end
$trimm = $line.TrimEnd()
# do we have a single letter. If so this is our parm. If the user didn't use a dash this will also work, so -i and i both work
$length = $trimm.length
if ( $length -eq 1 )
{
$sargopts = $sargopts + "&" + "$trimm" + "=true"
if ($trimm -eq "h")
{
$helprequest = "y"
}
$sargsortordertest = Get-SARGSortOrder -parmletter $trimm -reportname $reportname
if ( ($sargsortordertest -ne $null) -and ($sargsortordertest.sortorder -ne "") )
{
$sargreportsortorder = $sargsortordertest
}
}
# if length is greater than one then we either have a parm with search like -a 1232 or we have grouped parms like -ty
if ( $length -gt 1 )
{
$parmcount = $trimm | measure-object -word
# if we get one word and the first letter is a or d we are are going to assume its appID or days.
# its better for the user to always leave a space between letter and search object, so -a 123 rather than -a123
if ( $parmcount.words -eq 1 )
{
if ( ($trimm[0] -eq "a") -or ($trimm[0] -eq "d") )
{
$namepayload = "'" + $trimm.substring(1) + "'"
$sargopts = $sargopts + "&" + $trimm[0] + "=" + [System.Web.HttpUtility]::UrlEncode($namepayload)
}
# if we find only one word then all the parms are together like -ty so we process them one at a time
else
{
$splitblob = $trimm.tochararray()
foreach ($blob in $splitblob)
{
$sargopts = $sargopts + "&" + "$blob" + "=true"
if ($blob -eq "h")
{
$helprequest = "y"
}
# test if we have a matching sort order parm
$sargsortordertest = Get-SARGSortOrder -parmletter $blob -reportname $reportname
if ( ($sargsortordertest -ne $null) -and ($sargsortordertest.sortorder -ne "") )
{
$sargreportsortorder = $sargsortordertest
}
}
}
}
# if we have more then one word then we have a search like -a 1234
if ( $parmcount.words -gt 1 )
{
# the first word will be the parm If the first word is more than one character long then there is an issue and we ignore it
$firstword = $trimm.Split([Environment]::Space) | Select-Object -First 1
$length = $firstword.length
if ( $length -eq 1 )
{
# the second word should be the search term Spaces are not an issue
$namepayload = "'" + $trimm.substring(2) + "'"
$sargopts = $sargopts + "&" + "$firstword" + "=" + [System.Web.HttpUtility]::UrlEncode($namepayload)
# test if we have a matching sort order parm
$sargsortordertest = Get-SARGSortOrder -parmletter $firstword -reportname $reportname
if ( ($sargsortordertest -ne $null) -and ($sargsortordertest.sortorder -ne "") )
{
$sargreportsortorder = $sargsortordertest
}
}
}
}
}
if ($helprequest -eq "y")
{
$Url = "https://$env:acthost/actifio/api/report/$reportname" + "?" + "sessionid=$env:ACTSESSIONID" + "&h=true"
$helpgrab = Get-ActAPIData $Url
if (!($helpgrab.information))
{
$helpgrab
}
else
{
# we will remove any options that don't apply to PowerShell -w for column width -c for CSV -l for appname length and -n for no header
$helpgrab.information -notmatch ".column width to exactly match.|.comma separated variable.|.length of the app name.|.not print the header lines"
}
}
else
{
$Url = "https://$env:acthost/actifio/api/report/$reportname" + "?" + "sessionid=$env:ACTSESSIONID" + "$sargopts"
$sargoutput = Get-ActAPIData $Url
if (($sargoutput).errormessage -eq $null)
{
# if we got here we must have output we can sort, if we don't have a sort order yet, this is our last chance to get one
if ($sargreportsortorder -eq $null)
{
$sargreportsortorder = Get-SARGSortOrder -parmletter "-" -reportname $reportname
}
# if we still don't have a sort order, just give the output without it
if (($sargreportsortorder.SortOrder -eq "") -or ($sargreportsortorder.SortOrder -eq $null) )
{
$sargoutput
}
else
{
$sargoutput | select-object $sargreportsortorder.SortOrder.split(",")
}
}
else
{
$sargoutput
return
}
}
}
else
{
$Url = "https://$env:acthost/actifio/api/report/$reportname" + "?sessionid=$env:ACTSESSIONID"
$sargoutput = Get-ActAPIData $Url
if (($sargoutput).errormessage -eq $null)
{
$sargreportsortorder = Get-SARGSortOrder -parmletter "-" -reportname $reportname
if (($sargreportsortorder.SortOrder -eq "") -or ($sargreportsortorder.SortOrder -eq $null) )
{
$sargoutput
}
else
{
$sargoutput | select-object $sargreportsortorder.SortOrder.split(",")
}
}
else
{
$sargoutput
}
}
}
# we dont want to precreate all the SARG functions, but reportlist is a good one to help the client understand if SARG commands dont work.
function reportlist ()
{
if ( (!($env:ACTSESSIONID)) -or (!($env:acthost)) )
{
Get-ActErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-Act. Report commands are only loaded after you login to an Appliance."
return;
}
if (!($args))
{
Get-InternalSARGReport reportlist "-p" | select-object ReportName,ReportFunction,FriendlyName,RequiredRoleRights
}
else {
Get-InternalSARGReport reportlist $args
}
}
# create the functions so that report* commands work like they do with SSH CLI
function New-SARGFuncs()
{
<#
.SYNOPSIS
This is an internal function used to fetch report commands from the appliance. You do not use this function directly
#>
# make sure we have something to connect to
if ( (!($env:ACTSESSIONID)) -or (!($env:acthost)) )
{
Get-ActErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-Act"
return;
}
$Url = "https://$env:acthost/actifio/api/report/reportlist?p=true&sessionid=$env:ACTSESSIONID"
Try
{
if ( ($env:IGNOREACTCERTS -eq "y") -and ($((get-host).Version.Major) -gt 5) )
{
$reportlistout = Invoke-RestMethod -SkipCertificateCheck -Method Get -Uri $Url -TimeoutSec $env:acttimeout
}
else
{
$reportlistout = Invoke-RestMethod -Method Get -Uri $Url -TimeoutSec $env:acttimeout
}
}
Catch
{
$RestError = $_
}
if ($RestError)
{
Test-ActJSON $RestError
}
else
{
$sargcmdlist = $reportlistout.result.ReportName
}
# get the list of sarg commands and set an item for each
foreach ($cmd in $sargcmdlist)
{
set-item -path function:global:$cmd -value { Get-InternalSARGReport $cmd $args}.getNewClosure();
}
if ($env:ACTSORTOVERRIDE -eq "n")
{
$sortorderfetch = reportlist -s
if ($sortorderfetch.SortOrder -ne $null)
{
$global:ACTSORTORDER = $sortorderfetch
}
else
{
$mp = (Get-Module -ListAvailable ActPowerCLI).ModuleBase
if ( Test-Path $mp\ActPowerCLI_SortOrder.csv )
{
$global:ACTSORTORDER = Import-Csv -Path $mp\ActPowerCLI_SortOrder.csv -Delimiter ","
}
}
}
if ($env:ACTSORTOVERRIDE -eq "f")
{
$mp = (Get-Module -ListAvailable ActPowerCLI).ModuleBase
if ( Test-Path $mp\ActPowerCLI_SortOrder.csv )
{
$global:ACTSORTORDER = Import-Csv -Path $mp\ActPowerCLI_SortOrder.csv -Delimiter ","
}
}
if ($env:ACTSORTOVERRIDE -eq "y")
{
$global:ACTSORTORDER = ""
}
}
# this function will imitate udsinfo so that users don't need to remember each individual function
# handle request for udsinfo command
Function udsinfo([string]$subcommand, [switch][alias("h")]$help)
{
<#
.SYNOPSIS
Executes udsinfo commands via a rest API hosted on VDP Appliance.
.EXAMPLE
udsinfo lsuser
list users on connect VDP appliance.
.EXAMPLE
udsinfo lsapplication 12345
List details about application id 12345
.EXAMPLE
udsinfo lsapplication -filtervalue appname=*db*
List any applications that contain "db" in the name
.EXAMPLE
udsinfo lsapplication -filtervalue "appname=*db*&hostid=333620"
List any applications that contain "db" in the appname and are a match
for hostid 333620. The filtervalue here needs to be quoted because & is
a reserved special character in Powershell.
.EXAMPLE
udsinfo -h
See all the available subcommands to udsinfo
.EXAMPLE
udsinfo lsapplication -h
See the help information for lsapplication subcommand.
.DESCRIPTION
Once you have connected to a VDP Appliance using Connect-Act, you can execute
udsinfo with a subcommand to return information from a VDP Appliance . Udsinfo commands
allow you to retrieve information and settings from a VDP Appliance. These commands can be
safely executed without any danger to the system.
use udsinfo -h to get the list of possible subcommands.
udsinfo SUBCOMMAND -h will provide help on that specific topic.
Help is retrieved dynamically from a VDP Appliance .
.PARAMETER subcommand
Required. Subcommand to udsinfo. Example: lshost, lsuser, lsapplication.
.PARAMETER argument
Optional. Use argument to get more information about a specific object.
Example: lshost sql01 or lshost 2342
.PARAMETER filtervalue
Optional. Can be used to filter the information received from a VDP Appliance.
Filtervalue is ignored when argument is provided.
Example: lshost -filtervalue hostanme=exch*
.PARAMETER help
Optional. Use this for getting subcommand help. Needs no value.
Example: lshost -h
.PARAMETER args
Arguments to be provided to the function that do not meet the requirements above.
Example: getgcschedule -type gc
#>
# make sure we have something to connect to
if ( (!($env:ACTSESSIONID)) -or (!($env:acthost)) )
{
Get-ActErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-Act"
return;
}
# if no subcommand is provided, display the list of subcommands and exit
if ( $subcommand -eq "" )
{
$Url = "https://$env:acthost/actifio/api/info/help" + "?sessionid=$env:ACTSESSIONID"
Get-ActAPIData $Url
return
}
if ( $help )
{
# if there's no subcommand, then get help for udsinfo -h. If not, udsinfo subcommand -h
if ( $subcommand -ne "")
{
$Url = "https://$env:acthost/actifio/api/info/help/$subcommand" + "?sessionid=$env:ACTSESSIONID"
Get-ActAPIData $Url
} else
{
$Url = "https://$env:acthost/actifio/api/info/help" + "?sessionid=$env:ACTSESSIONID"
Get-ActAPIData $Url
}
return
}
# we are going to send all the args that is not the argument or filtervalue in REST format as udsopts
$udsopts = $null
if ($args)
{
$udsopts = generatepayload($args)
}
# we didn't get asked for help so lets grab the output
# we always start at apistart of 0 which is the first result
$apistart = 0
# if somehow the default actmaxapilimit set at connect-act is gone, we set it again
if ( $env:actmaxapilimit -eq "" )
{
$env:actmaxapilimit = 0
}
# the api limit per command should be either 4096 or if the user set actmaxapilimit to a number 1-4095 then use that value
if (( $env:actmaxapilimit -gt 0 ) -and ( $env:actmaxapilimit -le 4096 ))
{
$maxlimitpercommand = $env:actmaxapilimit
}
else
{
$maxlimitpercommand = 4096
}
# we will keep looping grabbing 4096 objects per loop up till done = 1
$done = 0
Do
{
if ($udsopts -and $filtervalue)
{
$Encodedfilter = [System.Web.HttpUtility]::UrlEncode($filtervalue)
$Url = "https://$env:acthost/actifio/api/info/$subcommand" + "?sessionid=$env:ACTSESSIONID" + "&filtervalue=" + "$Encodedfilter" + "$udsopts" + "&apistart=$apistart" + "&apilimit=$maxlimitpercommand"
$output = Get-ActAPIData $Url
}
elseif ($udsopts)
{
$Url = "https://$env:acthost/actifio/api/info/$subcommand" + "?sessionid=$env:ACTSESSIONID" + "$udsopts" + "&apistart=$apistart" + "&apilimit=$maxlimitpercommand"
$output = Get-ActAPIData $Url
}
elseif ($filtervalue)
{
$Encodedfilter = [System.Web.HttpUtility]::UrlEncode($filtervalue)
$Url = "https://$env:acthost/actifio/api/info/$subcommand" + "?sessionid=$env:ACTSESSIONID" + "&filtervalue=" + "$Encodedfilter" + "&apistart=$apistart" + "&apilimit=$maxlimitpercommand"
$output = Get-ActAPIData $Url
}
else
{
$Url = "https://$env:acthost/actifio/api/info/$subcommand" + "?sessionid=$env:ACTSESSIONID" + "&apistart=$apistart" + "&apilimit=$maxlimitpercommand"
$output = Get-ActAPIData $Url
}
# count the results and add 4096 to apistart. If we got less than 4096 we are done and can finish by settting done to 1
$objcount = $output.count
$output
# if less than 4096 we are either finished or hit the max and we can drop out
if ( $objcount -lt 4096)
{
$done = 1
}
# we add 4096 by default for the next grab of data
else
{
$apistart = $apistart + 4096
$nextlimit = $apistart + 4096
}
if ( $apistart -eq $env:actmaxapilimit)
{
$done = 1
}
# we now need to consider if the maxlimit should be trimmed
if (($env:actmaxapilimit -gt 4096) -and ( $nextlimit -gt $env:actmaxapilimit))
{
$maxlimitpercommand = $env:actmaxapilimit - $apistart
}
} while ($done -eq 0)
}
Function udstask ([string]$subcommand, [switch][alias("h")]$help)
{
<#
.SYNOPSIS
Executes udstask commands via a rest API hosted on a VDP Appliance.
.EXAMPLE
udstask mkuser -h
See help for the mkuser subcommand.
.EXAMPLE
udstask mkuser -name john.doe -password Password12345
Create a new user named "john.doe" with a password. Additional optional fields can be specified as well. See help.
.EXAMPLE
udstask backup -app 4222 -policy 4111
Run an on demand backup job for app id 4222 with policy 4111.
.EXAMPLE
udstask -h
See all the available subcommands to udstask
.DESCRIPTION
Once you have connected to a VDP Appliance using Connect-Act, you can execute
udstask with a subcommand to make changes on a VDP Appliance. Udstask commands conduct
actions on a VDP Appliance. Actions such as creation of hosts, users, running
jobs, etc.
Output from VDP APpliances is always presented as an object.
use udstask -h to get the list of possible subcommands.
udstask SUBCOMMAND -h will provide help on that specific topic.
Help is retrieved dynamically from a VDP Appliance.
.PARAMETER subcommand
Required. Subcommand to udstask. Example: mkhost, mkuser, mksla.
.PARAMETER help