Dictionaries/Dict.Macos/Dict.MacOS.psm1
|
<#
.SYNOPSIS Create a new scheduled task / cron job .DESCRIPTION Create a full scheduled task / cron job with one command. .PARAMETER Folder Optional Folder name into which to create the task .PARAMETER Name Name of the task .PARAMETER Command Command or script to run .PARAMETER Parameters Arguments to pass to the command .PARAMETER Description Optional description of the task .PARAMETER Username Username to use to launch the task default = root .PARAMETER Minutes Set the minutes number to trigger job (can be '*' to run every minutes). Default = '*' .PARAMETER Hour Set the hour number to trigger job (can be '*' to run every hours). Default = '*' .PARAMETER DayOfMonth Set the day of the month number to trigger job (can be '*' to run every days). Default = '*' .PARAMETER DayOWeek Set the day of week number to trigger job (can be '*' to run every days of week). Default = '*' .PARAMETER Month Set the month number to trigger job (can be '*' to run every months). Default = '*' .PARAMETER Year Set the year number to trigger job (can be '*' to run every years). Default = '*' .PARAMETER EveryMinutes Equals to -Minute '*' .PARAMETER Hourly Equals to -Minute 0 -Hours '*' .PARAMETER Daily Equals to -Minute 0 -Hours 0 -DayOfMonth '*' .PARAMETER Weekly Equals to -Minute 0 -Hours 0 -DayOfWeek 1 -Week '*' .PARAMETER Monthly Equals to -Minute 0 -Hours 0 -DayOfMonth 1 -Month '*' .PARAMETER Yearly Equals to -Minute 0 -Hours 0 -DayOfMonth 1 -Month 1 -Year '*' .PARAMETER AtStartup Trigger job on system startup .PARAMETER AtLogon Trigger job on session logon .EXAMPLE An example .NOTES General notes #> function New-PwShFwScheduledTask { [CmdletBinding(DefaultParameterSetName = 'EXACT_TRIGGER')] [OutputType([String])] Param ( [string]$Folder, [Parameter(Mandatory = $true, ValueFromPipeLine = $true)][string]$Name, [Parameter(Mandatory = $true, ValueFromPipeLine = $true)][string]$Command, [Parameter(Mandatory = $false, ValueFromPipeLine = $true)][string]$Parameters, [string]$Description, [string]$Username = "root", [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$Minute = '*', [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$Hour = '*', [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$DayOfMonth = '*', [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$DayOfWeek = '*', # [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$Week = '*', [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$Month = '*', [Parameter(ParameterSetName = 'EXACT_TRIGGER')][string]$Year = '*', [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$EveryMinutes, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$Hourly, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$Daily, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$Weekly, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$Monthly, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$Yearly, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$AtStartup, [Parameter(ParameterSetName = 'ALIAS_TRIGGER')][switch]$AtLogon ) Begin { Write-EnterFunction $Filename = $Folder ? "/usr/lib/cron/jobs/$Folder-$Name" : "/usr/lib/cron/jobs/$Name" } Process { $scheduleString = "" switch ($PSCmdlet.ParameterSetName) { 'EXACT_TRIGGER' { $scheduleString = "$Minute $Hour $DayOfMonth $Month $DayOfWeek" } 'ALIAS_TRIGGER' { if ($EveryMinutes) { $scheduleString = "* * * * *" } if ($Hourly) { $scheduleString = "0 * * * *" } if ($Daily) { $scheduleString = "0 0 * * *" } if ($Weekly) { $scheduleString = "0 0 * * 0" } if ($Monthly) { $scheduleString = "0 0 1 * *" } if ($Yearly) { $scheduleString = "0 0 1 1 *" } if ($AtStartup) { $scheduleString = "@reboot" } } } $task = @" SHELL=/bin/sh PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin # $Description $ScheduleString $Username $Command $Parameters "@ try { $task | Out-File -FilePath $Filename -Encoding utf8 $rc = $? } catch { eerror $_ $rc = $false } return $rc } End { Write-LeaveFunction } } |