Hi Guys,
Is there any documentation or examples on how to create custom powershell functions in WFA? Below is some powershell code I wrote to connect to filer and volume then compare the volume's available space to a specified threshold in gigabytes. The function returns True or False based on the volumes available space if it is greater than or equal to the threshold provided. (And yes i know you could query the DFM cache for this but I just want an example of how to query the filer directly for a property of a storage object which might not be in the DFM cache)
My questions are:
- What is the sytax to convert powershell code into a WFA command?
- What is the "Advanced Properties" string when creating a WFA command? Should this represent the input or output of the function?
- Where is the SDK for the WFA function scripting language?
- How can the return value of the (True\False) of the function be used to determine the workflow execution?
- What parameters does the "Get-WFALogger" support. For example "-Info" "-warn" "-error"? (or is the first parameter just a string to including in the logging function?)
Cheers Matt
#'---------------------------------------------------------------------------------
Function Test-VolumeSize{
<#
.SYNOPSIS
Connects to a filer and volume to determine if the available space is greater
than or equal to a given threshold value in gigabytes.
.DESCRIPTION
The function returns True or False based on the volumes available space
in comparison to the threshold value specified.
.PARAMETER
Hostname is a string containing the netBIOS name of the filer to connect to.
.PARAMETER
volumeName is a string containing the Volume Name to check.
.PARAMETER
Threshold is an integer representing the minimum available gigabytes.
It is used to determine if a volume has sufficent capacity available.
.EXAMPLE
Test-VolumeSize filer1 aggr1 4000
#>
#'------------------------------------------------------------------------------
[CmdletBinding()]
Param(
[Parameter(Position=0,
Mandatory=$True,
ValueFromPipeLine=$True,
ValueFromPipeLineByPropertyName=$True)]
[string]$hostName,
[Parameter(Position=1,
Mandatory=$True,
ValueFromPipeLine=$True,
ValueFromPipeLineByPropertyName=$True)]
[string]$volumeName,
[Parameter(Position=2,
Mandatory=$True,
ValueFromPipeLine=$True,
ValueFromPipeLineByPropertyName=$True)]
[int]$threshold
)
#'------------------------------------------------------------------------------
#Connect to the storage controller.
#'------------------------------------------------------------------------------
Try{
Connect-NaController $hostName -ErrorAction "Stop" | Out-Null
#Write-Host "Connected to $hostName"
}Catch{
#Write-Host "Failed connecting to $hostName"
Break;
}
Try{
$volume = Get-NaVol $volumeName | Select-Object -Property Name,SizeAvailable
}Catch{
#Write-Host "Failed enumerating Volumes properties on aggregate $aggrName"
Break;
}
#'------------------------------------------------------------------------------
#Enumerate the volume size in GB for each volume and compare it to the threshold.
#'------------------------------------------------------------------------------
$sizeGB = ($volume.SizeAvailable / 1GB)
If($sizeGB -ge $threshold){
Return $True;
}Else{
Return $False;
}
}
#'---------------------------------------------------------------------------------
Import-Module "DataOnTap"
[string]$hostName = "filer1"
[string]$volumeName = "vol1"
[int]$threshold = 1000
#'---------------------------------------------------------------------------------
#'Check the volumes available space and determine if a share or volume should be created.
#'---------------------------------------------------------------------------------
If(Test-VolumeSize $hostName $volumeName $threshold){
Write-Host "Volume $volumeName on $hostName has sufficent capacity."
Write-Host "Create a new CIFS share"
}Else{
Write-Host "Volume $volumeName on $hostName does not have sufficent capacity."
Write-Host "Create new volume"
}
#'---------------------------------------------------------------------------------
My best guess at how to convert this into WFA is:
#'---------------------------------------------------------------------------------
Param(
[Parameter(Mandatory=$True, HelpMessage="Host name or IP Address")]
[string]$hostName,
[Parameter(Mandatory=$True, HelpMessage="Volume name")]
[string]$volumeName,
[Parameter(Mandatory=$True, HelpMessage="Desired Gigabytes available")]
[int]$threshold
)
Get-WFALogger -Info -message $("Connecting to " + $hostName)
Try{
Connect-WFAController -Array $hostName -ErrorAction "Stop"
}Catch{
Get-WFALogger -Error -message $("Connecting to " + $hostName)
Break;
}
Get-WFALogger -Info -message $("Connecting to volume " + $volumeName)
Try{
$volume = Get-NaVol $volumeName | Select-Object -Property Name,SizeAvailable
}Catch{
Get-WFALogger -Warn -message $("Connecting to volume " + $volumeName)
Break;
}
$sizeGB = ($volume.SizeAvailable / 1GB)
Get-WFALogger -Info -message $($volumeName + " volume has " + $sizeGB + " available space")
If($sizeGB -ge $threshold){
Get-WFALogger -Info -message $($volumeName + " has sufficent space")
Return $True;
}Else{
Get-WFALogger -Info -message $($volumeName + " does not have sufficent space")
Return $False;
}
#'---------------------------------------------------------------------------------
If this post resolved your issue, help others by selecting ACCEPT AS SOLUTION or adding a KUDO.
