VCF Operations for Logs | How to Automate URL Generation for Filtering Results

  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

# Function to send event data to Aria Operations for Logs

function Send-ApiEvent {
  Param (
      # Parameters with default values, can be overridden as needed.
      [string]$Uri              = 'https://vaol-vip.vcrocs.local:9543/api/v2/events',  # API Endpoint to send the event data
      [string]$priority         = 'info',                    # Event priority (info, warning, error, etc.)
      [string]$facility         = 'user',                    # Source generating the event (user, system, etc.)
      [string]$appname          = 'VCF_Automation',          # Application name logging the event
      [string]$hostname         = 'NA',                      # Hostname of the system (optional)
      [string]$vmw_esxi_vm_name = 'NA',                      # Name of the VM or ESXi host (optional)
      [string]$vmw_vcenter      = 'NA',                      # Name of the vCenter (optional)
      [string]$vmw_cluster      = 'NA',                      # Name of the vCenter cluster (optional)
      [string]$vmw_host         = 'NA',                      # Name of the vCenter Host (optional)
      [string]$Text             = "Custom Script execution"  # Custom text describing the event
  ) # End Param

  # Define headers for the REST API call, using JSON for content type and response format.
  $headers = @{
      'accept'       = 'application/json'
      'Content-Type' = 'application/json'
  } # End headers

  # Construct the JSON body for the API request using a here-string.
  $body = @"
  [
    {
      "priority": "$priority",
      "facility": "$facility",
      "appname":  "$appname",
      "hostname": "$hostname",
      "vmw_esxi_vm_name": "$vmw_esxi_vm_name",
      "vmw_vcenter": "$vmw_vcenter",
      "vmw_cluster": "$vmw_cluster",
      "vmw_host": "$vmw_host",
      "text": "$Text"
    }
  ]
"@ # End Body

  # Send the POST request to the API endpoint within a try-catch block for error handling.
  try {
      # Invoke-RestMethod is used to send the API request and return the response.
      $response = Invoke-RestMethod -Uri $Uri -Method Post -Headers $headers -Body $body -SkipCertificateCheck

      # Output the API response if successful.
      Write-Host "API response: " -ForegroundColor Green
      $response
  } catch {
      # Handle any errors that occur during the request and output the error message.
      Write-Host "Error occurred: $($_.Exception.Message)" -ForegroundColor Red
  } # End try/catch

} # Function End

# Example usage of the Send-ApiEvent function.
# Customize the message text, add relevant data to $text, and invoke the function.
#$text = "VM Build: " + "A new process has been created with ID 9876"
#Send-ApiEvent -Text $text -vmw_esxi_vm_name 'vCROCS-W2K22-02'




# Email Function using Gmail

function Send-ServerBuildEmail {
  param (
      [string]$fromEmail = "dale.hassinger@gmail.com",
      [string]$toEmail = "dale.hassinger@vcrocs.info",
      [string]$vmName,
      [string]$finalUrl
  )

  # Gmail email settings
  $appPassword = "klj-Hack-Me-ytl"
  $smtpServer  = "smtp.gmail.com"
  $smtpPort    = 587

  # Email subject
  $subject = "New Server Build: $vmName"

  # Build the Email body
  $body = '<!DOCTYPE html><html><head><meta charset="UTF-8"><title>vCROCS Automation</title>
      <style>
          body {
              background-color: #ffffff;
              color: #000000;
              font-family: Arial, sans-serif;
              font-size: 14px;
              margin: 0;
              padding: 20px;
          }
      </style></head><body>'
  $body += '<body><p>New Server Build: ' + $vmName + ' is Complete.</p>'
  $body += '<p>Link to View Server Build Logs within VCF Operations for Logs: <a href="' + $finalUrl + '">Click Here</a></p>'
  $body += '</body></html>'

  # Create the email message
  $emailMessage = New-Object system.net.mail.mailmessage
  $emailMessage.From = $fromEmail
  $emailMessage.To.Add($toEmail)
  $emailMessage.Subject = $subject
  $emailMessage.Body = $body
  $emailMessage.IsBodyHtml = $true  # Set to true to send HTML emails

  # Configure the SMTP client
  $smtpClient = New-Object system.net.mail.smtpclient($smtpServer, $smtpPort)
  $smtpClient.EnableSsl = $true  # Gmail requires SSL
  $smtpClient.Credentials = New-Object System.Net.NetworkCredential($fromEmail, $appPassword)

  # Send the email
  try {
      $smtpClient.Send($emailMessage)
      Write-Host "Email sent successfully."
  } catch {
      Write-Host "Failed to send email: $_"
  }

  # Clean up
  $smtpClient.Dispose()
}

# Example usage of the email function
#Send-ServerBuildEmail -toEmail "dale.hassinger@vcrocs.info" -vmName "vcrocs-w2k22-02" -finalUrl $Global:finalUrl





# Function to build URL for VCF Operations for Logs that will auto filter logs based on date|time, VM Name and text

function set-filterURL {

  param (
      [string]$appname = "vcf_automation",
      [string]$text = "VM Build:",
      [string]$vmwEsxiVmName = "vcrocs-w2k22-01"
  ) # End Param

  # ----- [ Get current time and 24 hours ago ] ----- 
  
  # Get the current date and time, add 5 minutes
  $currentDate = (Get-Date).AddMinutes(5)
  
  # Calculate the date and time 24 hours ago
  $pastDate = (Get-Date).AddHours(-24)

  # Convert both dates to Unix timestamps in milliseconds
  $epoch = [datetime]"1970-01-01 00:00:00"

  # Convert the current date to a Unix timestamp in milliseconds
  $currentTimestampMillis = [int64](($currentDate.ToUniversalTime() - $epoch).TotalMilliseconds)

  # Convert the past date (24 hours ago) to a Unix timestamp in milliseconds
  $pastTimestampMillis = [int64](($pastDate.ToUniversalTime() - $epoch).TotalMilliseconds)

  # Output the results
  #"Current time in milliseconds: $currentTimestampMillis"
  #"24 hours ago in milliseconds: $pastTimestampMillis"

  # Define the base URL
  $baseUrl = "https://192.168.6.97/explorer/?existingChartQuery="

  # Define the JSON object with placeholders for the parameters
  $jsonObject = @{
      query = ""
      startTimeMillis = $pastTimestampMillis
      endTimeMillis = $currentTimestampMillis
      piqlFunctionGroups = @(
          @{
              functions = @(
                  @{
                      label = "Count"
                      value = "COUNT"
                      requiresField = $false
                      numericOnly = $false
                  }
              )
              field = $null
          }
      )
      dateFilterPreset = "LAST_24_HOURS"
      shouldGroupByTime = $true
      includeAllContentPackFields = $true
      eventSortOrder = "DESC"
      summarySortOrder = "DESC"
      compareQueryOrderBy = "TREND"
      compareQuerySortOrder = "DESC"
      compareQueryOptions = $null
      messageViewType = "EVENTS"
      constraintToggle = "ALL"

      piqlFunction = @{
          label = "Count"
          value = "COUNT"
          requiresField = $false
          numericOnly = $false
      }
      piqlFunctionField = $null
      fieldConstraints = @(
          @{
              internalName = "appname"
              operator = "STARTS_WITH"
              value = $appname
          },
          @{
              internalName = "text"
              operator = "CONTAINS"
              value = $text
          },
          @{
              internalName = "vmw_esxi_vm_name"
              operator = "CONTAINS"
              value = $vmwEsxiVmName
          }
      )
      supplementalConstraints = @()
      groupByFields = @()
      contentPacksToIncludeFields = @()
      extractedFields = @()
  }

  # Convert the object to JSON
  $jsonString = $jsonObject | ConvertTo-Json -Compress -Depth 10

  # URL encode the JSON string
  $encodedJson = [System.Web.HttpUtility]::UrlEncode($jsonString)

  # Chart options (URL encoded)
  $chartOptions = "%7B%22logaxis%22%3Afalse%2C%22trendline%22%3Afalse%2C%22spline%22%3Afalse%7D"

  # Construct the final URL
  $global:finalUrl = $baseUrl + $encodedJson + "&chartOptions=" + $chartOptions

  # Output the final URL
  #$global:finalUrl

  Set-Clipboard $global:finalUrl

} # End Function

# Call Function to build Filter URL Example
#$vmName = "vcrocs-w2k22-02"
#set-filterURL -vmwEsxiVmName $vmName

# Open URL in default browser
#Start-Process $global:finalUrl

 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

# Load the Create Events, Create URL and Send Email functions script, which will be used for logging events via Aria Operations for Logs API.
. /Path-to-Script/aria-operations-for-logs-syslog-api.ps1

# Define the VM name and the script process description
$vmName = "vCROCS-W2K22-06"
$scriptProcess = "VM Build: " + $vmName

# --- Connect to vCenter ---

# Define the parameters for connecting to the vCenter Server
$ConnectVIServerParams = @{
    Server   = '192.168.6.100'              # vCenter Server IP or FQDN
    User     = 'administrator@vcrocs.local' # vCenter Admin Username
    Password = 'VMware1!'                   # vCenter Admin Password
    Protocol = 'https'                      # Secure Protocol
    Force    = $true                        # Force connection even if already connected
}

# Log the connection attempt to Aria Operations for Logs
$text = $scriptProcess + " - Connecting to vCenter Server: " + $ConnectVIServerParams.Server
Send-ApiEvent -text $text -vmw_vcenter $ConnectVIServerParams.Server -vmw_esxi_vm_name $vmName

# Establish the connection to vCenter
$vCenterConnect = Connect-VIServer @ConnectVIServerParams

# Log successful connection status to Aria Operations for Logs
$text = $scriptProcess + " - Connection to vCenter Server: " + $ConnectVIServerParams.Server + " Successful: " + $vCenterConnect.IsConnected
Send-ApiEvent -text $text -vmw_vcenter $ConnectVIServerParams.Server -vmw_esxi_vm_name $vmName

# --- Add Your VM Build Steps Here ---
# Insert your VM build process code below. This section is a placeholder for any actions you will take on the VM during the build.

# Example Log Event - Add specific operations during VM build (e.g., software installation, configuration, etc.)
$text = $scriptProcess + " - Installing VCF Operations for Logs Agent"
Send-ApiEvent -text $text -vmw_vcenter $ConnectVIServerParams.Server -vmw_esxi_vm_name $vmName

# --- Disconnect from vCenter ---

# Log the disconnection attempt from vCenter
$text = $scriptProcess + " - Disconnecting from vCenter Server"
Send-ApiEvent -text $text -vmw_vcenter $ConnectVIServerParams.Server -vmw_esxi_vm_name $vmName

# Disconnect from the vCenter Server without confirmation prompts
Disconnect-VIServer -Server $ConnectVIServerParams.Server -Confirm:$false

# Call Function to build Filter URL
set-filterURL -vmwEsxiVmName $vmName

# Example usage of the email function
Send-ServerBuildEmail -toEmail "dale.hassinger@vcrocs.info" -vmName $vmName -finalUrl $Global:finalUrl