maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix crontab formatting in example doc (#13712)

Browse source 
* Updating formatting

Fixing formatting

* Update CronTab.psm1
This commit is contained in:
Dave Goldman 2020-10-02 07:54:15 -04:00 committed by GitHub
parent e107ecd08d
commit b7cabd4063
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
demos/crontab/CronTab/CronTab.psm1
View file

@ -77,16 +77,22 @@ function Remove-CronJob {
<# <#
.SYNOPSIS .SYNOPSIS
Removes the exactly matching cron job from the cron table Removes the exactly matching cron job from the cron table
.DESCRIPTION .DESCRIPTION
Removes the exactly matching cron job from the cron table Removes the exactly matching cron job from the cron table
.EXAMPLE .EXAMPLE
Get-CronJob | Where-Object {%_.Command -like 'foo *'} | Remove-CronJob Get-CronJob | Where-Object {%_.Command -like 'foo *'} | Remove-CronJob
.RETURNVALUE .RETURNVALUE
None None
.PARAMETER UserName .PARAMETER UserName
Optional parameter to specify a specific user's cron table Optional parameter to specify a specific user's cron table
.PARAMETER Job .PARAMETER Job
Cron job object returned from Get-CronJob Cron job object returned from Get-CronJob
.PARAMETER Force .PARAMETER Force
Don't prompt when removing the cron job Don't prompt when removing the cron job
#> #>
@ -143,20 +149,28 @@ function New-CronJob {
0-23/2 or */2. 0-23/2 or */2.
.EXAMPLE .EXAMPLE
New-CronJob -Minute 10-30 -Hour 10-20/2 -DayOfMonth */2 -Command "/bin/bash -c 'echo hello' > ~/hello" New-CronJob -Minute 10-30 -Hour 10-20/2 -DayOfMonth */2 -Command "/bin/bash -c 'echo hello' > ~/hello"
.RETURNVALUE .RETURNVALUE
If successful, an object representing the cron job is returned If successful, an object representing the cron job is returned
.PARAMETER UserName .PARAMETER UserName
Optional parameter to specify a specific user's cron table Optional parameter to specify a specific user's cron table
.PARAMETER Minute .PARAMETER Minute
Valid values are 0 to 59. If not specified, defaults to *. Valid values are 0 to 59. If not specified, defaults to *.
.PARAMETER Hour .PARAMETER Hour
Valid values are 0-23. If not specified, defaults to *. Valid values are 0-23. If not specified, defaults to *.
.PARAMETER DayOfMonth .PARAMETER DayOfMonth
Valid values are 1-31. If not specified, defaults to *. Valid values are 1-31. If not specified, defaults to *.
.PARAMETER Month .PARAMETER Month
Valid values are 1-12. If not specified, defaults to *. Valid values are 1-12. If not specified, defaults to *.
.PARAMETER DayOfWeek .PARAMETER DayOfWeek
Valid values are 0-7. 0 and 7 are both Sunday. If not specified, defaults to *. Valid values are 0-7. 0 and 7 are both Sunday. If not specified, defaults to *.
.PARAMETER Command .PARAMETER Command
Command to execute at the scheduled time and day. Command to execute at the scheduled time and day.
#> #>
@ -190,12 +204,16 @@ function Get-CronJob {
<# <#
.SYNOPSIS .SYNOPSIS
Returns the current cron jobs from the cron table Returns the current cron jobs from the cron table
.DESCRIPTION .DESCRIPTION
Returns the current cron jobs from the cron table Returns the current cron jobs from the cron table
.EXAMPLE .EXAMPLE
Get-CronJob -UserName Steve Get-CronJob -UserName Steve
.RETURNVALUE .RETURNVALUE
CronJob objects CronJob objects
.PARAMETER UserName .PARAMETER UserName
Optional parameter to specify a specific user's cron table Optional parameter to specify a specific user's cron table
#> #>