VMware vRealize SaltStack Config as a Windows Server Admin - Part 5

Grains File:

This is what I learned about salt grains when using with a Windows OS.

• The default location of the grains file is in directory “C:\salt\conf".
• The grains file is named grains with no extension.

Example grains file:

NSXSecurityTAGs:
- vCROCS.Apps.VMware.SaltStack.Minion
vCenterTAGs:
- TAG-VM-WebServer
- TAG-VM-vCROCS
- TAG-App-Hugo

• “Grain Name”: “The value of the grain”.
• In my example I wanted the grain to be named “vCenterTags” and the values will be the vCenter TAG names “TAG-VM-vCROCS, TAG-VM-WebServer, TAG-App-Hugo”. I have (3) vCenter TAGs assigned to this VM. I will be able to create a SaltStack Config Target based on any of the TAGs.
• I like the formatting that is used for the grains file by using the function grains.append.

SaltStack Config Targets:

When I add the vCenter TAG information to the grains file I am then able to create SaltStack Config Targets based on the grain “vCenterTags”.

SaltStack Config Targets:

Click Here to see Larger Image of Screen Shot

SaltStack Config Target Definition:

Click Here to see Larger Image of Screen Shot

How to add the vCenter TAGs to the grains file on all your VMs in SaltStack Config:

Get the VM Names and All Assigned vCenter TAGs

PowerShell Script:

# ----- [ SSH SaltStack Config Server - Add vCenter TAGs to Minion Grains ] --------------------------

# Connect to vCenter before running this code
# Define your Credentials

# SSH to SaltStack Server - MUST HAVE POSH-SSH PowerShell Module Installed 
New-SSHSession -ComputerName 'SaltServer.vCROCS.info' 

# Test SSH Connection
$CheckSSHConnection = Get-SSHSession -SessionId 0
$CheckSSHConnection.Connected

$vmNames = Get-VM -Name vCROCS-VM-*
$vmNames = $vmNames | Sort-Object Name

foreach($vmName in $VMNames){
    $vmName.Name

    #Get VM Tag(s)
    $VMTags = Get-TagAssignment -Entity $vmName.Name
    $VMTags.Tag.Name

    foreach($vmTAG in $VMTags.Tag.Name){

        $sshCommand = 'salt "' + $vmName.Name + '" grains.append vCenterTAGs "' + $vmTAG + '"'
        $results = Invoke-SSHCommand -SessionId 0 -Command $sshCommand
    } # End Foreach

    # Sync Grains after adding new grain information
    $sshCommand = 'salt "' + $vmName.Name + '" saltutil.sync_grains'
    $results = Invoke-SSHCommand -SessionId 0 -Command $sshCommand
} # End Foreach

# ----- [ Terminate SSH Session ] -----------------------------
Remove-SSHSession -SessionId 0

Lessons Learned:

• Adding the POSH-SSH PowerShell module so you can create a SSH connection to the salt master opens up a lot of possibilities for your PowerShell Automation as a Windows Server Admin.
• Grains are a good way to create SaltStack Config Targets. Allows you to group VMs together the same way you can in vCenter.
• The Grains file is basically a Database that can be any information that you want to show about your VMs. In this Blog post I am adding vCenter TAGs to the minions but the information could be anything that helps you target VMs.
• If the default list of grains OOTB doesn’t show the information you want to see, you can easily add your own gains with a little bit of code.

Salt Links I found to be very helpful:

• SaltStack Cheat Sheet
• SaltStack Tutorials
• SaltStack Documentation
• SaltStack Community Slack Channel
• Learn vRealize Automation
• Learn SaltStack Config