Public/Operations/New-VCDSSupportBundle.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
function New-VCDSSupportBundle(){
    <#
    .SYNOPSIS
    Generate a new Cloud Director support bundle. This operation requires administrative permissions and may take a while.

    .DESCRIPTION
    Generate a new Cloud Director support bundle. This operation requires administrative permissions and may take a while.

    .PARAMETER InstanceId
    The Instance Id of the Cloud Director instance to generate the Support Bundle.

    .PARAMETER InstanceName
    The Instance Name of the Cloud Director instance to generate the Support Bundle.

    .PARAMETER EnvironmentId
    Optionally the Cloud Director Service Environment Id (the default is used if none is provided)

    .PARAMETER Download
    If the parameter is set to $true after the support bundle has been generated it will be download to the current working directory

    .EXAMPLE
    New-VCDSSupportBundle -InstanceName "CDS-Instance-01"
    Generates a new Cloud Director support bundle for the instance with the name "CDS-Instance-01" and returns the details of the support bundle object generated.

    .EXAMPLE
    New-VCDSSupportBundle -InstanceId "urn:vcdc:vcdInstance:182297f8-36d0-4901-9f1d-42a2524fa091" -Download
    Generates a new Cloud Director support bundle for the provided instance and downloads the bundle files to the current working directory.

    .NOTES
    AUTHOR: Adrian Begg
    LASTEDIT: 2020-04-02
    VERSION: 1.0
    #>

    [CmdletBinding(DefaultParameterSetName="ByInstanceId")]
    Param(
        [Parameter(Mandatory=$True, ParameterSetName="ByInstanceId")]
            [ValidateNotNullorEmpty()]  [string] $InstanceId,
        [Parameter(Mandatory=$True, ParameterSetName="ByInstanceName")]
            [ValidateNotNullorEmpty()]  [string] $InstanceName,
        [Parameter(Mandatory=$False, ParameterSetName="ByInstanceId")]
        [Parameter(Mandatory=$False, ParameterSetName="ByInstanceName")]
            [ValidateNotNullorEmpty()] [String] $EnvironmentId,
            [switch]$Download
    )
    if(!$global:VCDService.IsConnected){
        throw "You are not currently connected to the VMware Console Services Portal (CSP) for VMware Cloud Director Service. Please use Connect-VCDService cmdlet to connect to the service and try again."
    }
    # Next check if the EnvironmentId has been provided and is valid
    if($PSBoundParameters.ContainsKey("EnvironmentId")){
        $Environment = $global:VCDService.VCDSEnvironments | Where-Object {$_.id -eq $EnvironmentId}
        if($Environment.count -eq 0){
            throw "An VCDS Environment with the Id $EnvironmentId can not be found. Please check the Id and try again."
        }
    } else {
        $Environment = $global:VCDService.DefaultEnvironment
    }
    # Setup a Service URI for the environment
    $ServiceURI = $Environment.url

    if($PSCmdlet.ParameterSetName -eq "ByInstanceName") {
        # Check if an instance already exists with the provided Name
        $Instance = Get-VCDSInstances -EnvironmentId $Environment.id -Name $InstanceName
        if($Instance.count -eq 0){
            throw "An instance with the Name $InstanceName can not be found in the environment with the Id $($Environment.id) please check the Name and try again."
        }
    }
    if($PSCmdlet.ParameterSetName -eq "ByInstanceId") {
        # Check if an instance already exists with the provided Id
        $Instance = Get-VCDSInstances -EnvironmentId $Environment.id -Id $InstanceId
        if($Instance.count -eq 0){
            throw "An instance with the Id $InstanceId can not be found in the environment with the Id $($Environment.id) please check the Name and try again."
        }
    }

    # Setup a HashTable for the API call to the Cloud Gateway
    $InstanceOperationAPIEndpoint = "$ServiceURI/environment/$($Environment.id)/instances/$($Instance.id)/operations/invokeOperation"
    [Hashtable] $htPayload = @{
        operationType = "CREATE_SUPPORT_BUNDLE"
        arguments = @{}
    }

    # A Hashtable of Request Parameters
    [Hashtable] $RequestParameters = @{
        URI = $InstanceOperationAPIEndpoint
        Method = "Post"
        ContentType = "application/json"
        Headers = @{
            "Authorization" = "Bearer $($global:VCDService.AccessToken)"
            "Accept" = "application/json"
        }
        Body = (ConvertTo-Json $htPayload)
        UseBasicParsing = $true
    }
    try{
        # Create the support bundle and wait for the task to complete
        $CreateSupportBundleTask = ((Invoke-WebRequest @RequestParameters).Content | ConvertFrom-Json)
        if(!(Watch-VCDSTaskCompleted -Task $CreateSupportBundleTask -Timeout 1800)){
            throw "An error occurred creating the support bundle $($CreateSupportBundleTask) please check the console and try the operation again."
        } else {
            # Get the support bundle task
            $SupportBundleTask = Get-VCDSTasks -Id $CreateSupportBundleTask.id -IncludeFiles
            # Check if the files should be downloaded
            if($Download){
                # Now download each of the support bundle files locally
                foreach($supportBundleFile in $SupportBundleTask.files){
                    $DownloadURI =  "$ServiceURI/environment/$($Environment.id)/tasks/$($SupportBundleTask.id)/files/$($supportBundleFile.id)/download"
                    $OutputFileName = "$($pwd.Path)\$($supportBundleFile.name)"
                    [Hashtable] $DownloadRequestParameters = @{
                        URI = $DownloadURI
                        Method = "Get"
                        ContentType = "application/json"
                        Headers = @{
                            "Authorization" = "Bearer $($global:VCDService.AccessToken)"
                            "Accept" = "application/json"
                            "Accept-Encoding" = "gzip, deflate, br"
                        }
                        UseBasicParsing = $true
                        OutFile = $OutputFileName
                    }
                    # Make the API Call to create the file
                    (Invoke-WebRequest @DownloadRequestParameters) | Out-Null
                }
            }
            return $SupportBundleTask
        }
    } catch {
        throw "An exception has occurred attempting to make the API call to create the support bundle. $_"
    }
}