SaltStackConfig.psm1
|
<#
Copyright 2021 VMware, Inc. SPDX-License-Identifier: BSD-2-Clause #> Function Connect-SscServer { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS Use this function to create the cookie/header to connect to SaltStack Config RaaS API .DESCRIPTION This function will allow you to connect to a vRealize Automation SaltStack Config RaaS API. A global variable will be set with the Servername & Cookie/Header value for use by other functions. .EXAMPLE PS C:\> Connect-SscServer -Server 'salt.example.com' -Username 'root' -Password 'VMware1!' This will default to internal user authentication. .EXAMPLE PS C:\> Connect-SscServer -Server 'salt.example.com' -Username 'bwuchner' -Password 'MyPassword1!' -AuthSource 'LAB Directory' This will use the 'Lab Directory' LDAP authentication source. .EXAMPLE PS C:\> Connect-SscServer -Server 'salt.example.com' This will prompt for credentials .EXAMPLE $creds = Get-Credential PS C:\> Connect-SscServer -Server 'salt.example.com' -Credential $creds -AuthSource 'LAB Directory' This will connect to the 'LAB Directory' LDAP authentication source using a specified credential. #> param( [Parameter(Mandatory=$true, Position=0)][string]$server, [Parameter(Mandatory=$true, ParameterSetName='PlainText', Position=1)][string]$username, [Parameter(Mandatory=$true, ParameterSetName='PlainText', Position=2)][ValidateNotNullOrEmpty()][string]$password, [Parameter(Mandatory=$false, Position=3)][string]$AuthSource='internal', [Parameter(Mandatory=$false, ParameterSetName='Credential')][PSCredential]$Credential, [Parameter(Mandatory=$false)][Switch]$SkipCertificateCheck, [Parameter(Mandatory=$false)][System.Net.SecurityProtocolType]$SslProtocol ) if ($PSCmdlet.ParameterSetName -eq 'Credential' -AND $Credential -eq $null) { $Credential = Get-Credential} if ($Credential) { $username = $Credential.GetNetworkCredential().username $password = $Credential.GetNetworkCredential().password } if ($SkipCertificateCheck) { # This if statement is using example code from https://stackoverflow.com/questions/11696944/powershell-v3-invoke-webrequest-https-error add-type @" using System.Net; using System.Security.Cryptography.X509Certificates; public class TrustAllCertsPolicy : ICertificatePolicy { public bool CheckValidationResult( ServicePoint srvPoint, X509Certificate certificate, WebRequest request, int certificateProblem) { return true; } } "@ [System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy } # end if SkipCertificate Check if ($SslProtocol) { [System.Net.ServicePointManager]::SecurityProtocol = $SslProtocol } $loginBody = @{'username'=$username; 'password'=$password; 'config_name'=$AuthSource} try { $webRequest = Invoke-WebRequest -Uri "https://$server/account/login" -SessionVariable ws $ws.headers.Add('X-Xsrftoken', $webRequest.headers.'x-xsrftoken') $webRequest = Invoke-WebRequest -Uri "https://$server/account/login" -WebSession $ws -method POST -body (ConvertTo-Json $loginBody) $webRequestJson = ConvertFrom-JSON $webRequest.Content $global:DefaultSscConnection = New-Object psobject -property @{ 'SscWebSession'=$ws; 'Name'=$server; 'ConnectionDetail'=$webRequestJson; 'User'=$webRequestJson.attributes.config_name +'\'+ $username; 'Authenticated'=$webRequestJson.authenticated; PSTypeName='SscConnection' } # Return the connection object $global:DefaultSscConnection } catch { Write-Error ("Failure connecting to $server. " + $_) } # end try/catch block } Function Disconnect-SscServer { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This function clears a previously created cookie/header used to connect to SaltStack Config .DESCRIPTION This function will clear the global variable used to connect to the vRealize Automation SaltStack Config RaaS API .EXAMPLE PS C:\> Disconnect-SscServer #> if ($global:DefaultSscConnection) { $global:DefaultSscConnection = $null } else { Write-Error 'Could not find an existing connection.' } # end if } Function Get-SscData { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS Use this function to call the SaltStack Config API. Additional helper functions will call this function, this is where the majority of the logic will happen. .DESCRIPTION This function will pass resource/method/arguments to the vRealize Automation SaltStack Config RaaS API. It depends on a global variable created by Connect-SscServer. .EXAMPLE PS C:\> Get-SscData -Resource 'minions' -Method 'get_minion_cache' #> param( [Parameter(Mandatory=$true)][string]$resource, [Parameter(Mandatory=$true)][string]$method, [System.Collections.Hashtable]$kwarg ) if (!$global:DefaultSscConnection) { Write-Error 'You are not currently connected to any servers. Please connect first using Connect-SscServer.' return; } # end if if (!$kwarg) { $body = @{'resource'=$resource; 'method'=$method } } else { $body = @{'resource'=$resource; 'method'=$method; 'kwarg'=$kwarg } } try{ $output = Invoke-WebRequest -WebSession $global:DefaultSscConnection.SscWebSession -Method POST -Uri "https://$($global:DefaultSscConnection.Name)/rpc" -body $(ConvertTo-Json $body) -ContentType 'application/json' $outputJson = (ConvertFrom-Json $output.Content) if ($outputJson.error) { Write-Error $outputJson.error } if ($outputJson.warnings) { Write-Warning $outputJson.warnings } return $outputJson.ret } catch { Write-Error $_.Exception.Message } } # Lets include a couple sample/helper functions wrappers Function Get-SscMaster { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This wrapper function will return grain details about the SaltStack Config master node. .DESCRIPTION This wrapper function will call Get-SscData master.get_master_grains. .EXAMPLE PS C:\> Get-SscMaster #> (Get-SscData master get_master_grains).salt.grains } Function Get-SscMinionCache { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This wrapper function will return the grain property cache of SaltStack Config minions. .DESCRIPTION This wrapper function will call Get-SscData minions.get_minion_cache. .EXAMPLE PS C:\> Get-SscMinion #> (Get-SscData minions get_minion_cache).results } Function Get-SscJob { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This wrapper function will return configured SatlStack Config jobs. .DESCRIPTION This wrapper function will call Get-SscData job.get_jobs. .EXAMPLE PS C:\> Get-SscJob #> (Get-SscData job get_jobs).results } Function Get-SscSchedule { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This wrapper function will return schedules for SaltStack Config. .DESCRIPTION This wrapper function will call Get-SscData schedule.get. .EXAMPLE PS C:\> Get-SscSchedule #> (Get-SscData schedule get).results } Function Get-SscReturn { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This wrapper function will return job results from the job cache based on the provided arguments. .DESCRIPTION This wrapper function will call Get-SscData ret.get_returns with either Jid or MinionID. .EXAMPLE PS C:\> Get-SscReturn .EXAMPLE PS C:\> Get-SscReturn -Jid '20211122160147314949' .EXAMPLE PS C:\> Get-SscReturn -MinionID 't147-win22-01.lab.enterpriseadmins.org' .EXAMPLE PS C:\> Get-SscReturn -MinionID 't147-win22-01.lab.enterpriseadmins.org' -Jid '20211122160147314949' #> param( [string]$jid, [string]$MinionID ) $kwarg = @{} if ($jid) { $kwarg += @{'jid'=$jid} } if ($MinionID) { $kwarg += @{'minion_id'=$MinionID} } (Get-SscData ret get_returns $kwarg).results } Function Get-SscActivity { <# .NOTES =========================================================================== Created by: Brian Wuchner Date: November 27, 2021 Blog: www.enterpriseadmins.org Twitter: @bwuch =========================================================================== .SYNOPSIS This wrapper function will return SaltStack Config commands that have been issued. In the web interface this is similar to the Activity button. .DESCRIPTION This wrapper function will call Get-SscData cmd.get_cmds. .EXAMPLE PS C:\> Get-SscActivity #> (Get-SscData cmd get_cmds).results } |