VCF Operations for Logs | How to use with Automation Scripts

 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

# This is a Fuction to send log events to VCF 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. url and port listed.
      [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 = "PowerShell: " + "A new process has been created with ID 9876"
Send-ApiEvent -Text $text
 

 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

# This is a example script to give you ideas on how to use the function listed above.

# Load the Syslog function 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-02"
$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 vCenter
$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
 

 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

 
function Send-SyslogMessage {
    Param (
        [string]$IP             = "192.168.6.94",        # Default Syslog server IP
        [int]$Port              = 514,                   # Default Syslog server UDP port
        [string]$Facility       = "syslog",              # Default Syslog facility
        [string]$Severity       = "info",                # Default Syslog severity
        [string]$Content        = "No Content provided", # Default Message content
        [string]$SourceHostname = "VCF-Automation",      # Default Hostname
        [string]$Tag            = "PS-Script"            # Default Tag for the message
    )

    # Map RFC 3164 facilities to numeric values
    $facilityMap = @{
        kern      = 0; user      = 1; mail      = 2;  daemon   = 3; 
        auth      = 4; syslog    = 5; lpr       = 6;  news     = 7;
        uucp      = 8; cron      = 9; authpriv  = 10; ftp      = 11;
        ntp       = 12; audit    = 13; alert    = 14; clock    = 15;
        local0    = 16; local1   = 17; local2   = 18; local3   = 19;
        local4    = 20; local5   = 21; local6   = 22; local7   = 23;
    }

    # Map RFC 3164 severities to numeric values
    $severityMap = @{
        emerg     = 0; alert     = 1; crit      = 2; err       = 3;
        warn      = 4; notice    = 5; info      = 6; debug     = 7;
    }

    # Resolve facility and severity values
    $facilityValue = $facilityMap[$Facility.ToLower()]
    $severityValue = $severityMap[$Severity.ToLower()]

    if (-not $facilityValue) { $facilityValue = $facilityMap["syslog"] }  # Default to syslog
    if (-not $severityValue) { $severityValue = $severityMap["info"] }    # Default to informational

    # Calculate the syslog priority value
    $pri = "<" + (($facilityValue * 8) + $severityValue) + ">"

    # Timestamp in RFC 3164 format
    $timestamp = (Get-Date).ToString("MMM dd HH:mm:ss")

    # Create the syslog message
    $header = "$timestamp $SourceHostname "
    $msg = $pri + $header + $Tag + ": " + $Content

    # Display the message to be sent
    # Write-Host "Sending syslog message: $msg"

    # Convert message to ASCII bytes
    $byteArray = [System.Text.Encoding]::ASCII.GetBytes($msg)

    # Send the message via UDP
    $udpClient = New-Object System.Net.Sockets.UdpClient
    $udpClient.Connect($IP, $Port)
    $udpClient.Send($byteArray, $byteArray.Length) | Out-Null
    $udpClient.Close()

    $output = "Syslog message sent to " + $IP + ":" + $Port
    Write-Host $output
}

# Example usage of the function
Send-SyslogMessage -Content "Creating PS Script for Syslog"