diff options
| author | Dave Goldman <39909564+dgoldman-msft@users.noreply.github.com> | 2020-10-02 14:54:15 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-02 14:54:15 +0300 |
| commit | b7cabd4063233176dbd3d38cd60a1e6e8cdd652c (patch) | |
| tree | 33b6f426ec7ec71b0cd08f0672029cd1cb1aae3a /demos | |
| parent | e107ecd08d68cc67512cd833a355dca868bd5a03 (diff) | |
Fix crontab formatting in example doc (#13712)
* Updating formatting
Fixing formatting
* Update CronTab.psm1
Diffstat (limited to 'demos')
| -rw-r--r-- | demos/crontab/CronTab/CronTab.psm1 | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/demos/crontab/CronTab/CronTab.psm1 b/demos/crontab/CronTab/CronTab.psm1 index d354419c9b..4cb88e586b 100644 --- a/demos/crontab/CronTab/CronTab.psm1 +++ b/demos/crontab/CronTab/CronTab.psm1 @@ -77,16 +77,22 @@ function Remove-CronJob { <# .SYNOPSIS Removes the exactly matching cron job from the cron table + .DESCRIPTION Removes the exactly matching cron job from the cron table + .EXAMPLE Get-CronJob | Where-Object {%_.Command -like 'foo *'} | Remove-CronJob + .RETURNVALUE None + .PARAMETER UserName Optional parameter to specify a specific user's cron table + .PARAMETER Job Cron job object returned from Get-CronJob + .PARAMETER Force Don't prompt when removing the cron job #> @@ -143,20 +149,28 @@ function New-CronJob { 0-23/2 or */2. .EXAMPLE New-CronJob -Minute 10-30 -Hour 10-20/2 -DayOfMonth */2 -Command "/bin/bash -c 'echo hello' > ~/hello" + .RETURNVALUE If successful, an object representing the cron job is returned + .PARAMETER UserName Optional parameter to specify a specific user's cron table + .PARAMETER Minute Valid values are 0 to 59. If not specified, defaults to *. + .PARAMETER Hour Valid values are 0-23. If not specified, defaults to *. + .PARAMETER DayOfMonth Valid values are 1-31. If not specified, defaults to *. + .PARAMETER Month Valid values are 1-12. If not specified, defaults to *. + .PARAMETER DayOfWeek Valid values are 0-7. 0 and 7 are both Sunday. If not specified, defaults to *. + .PARAMETER Command Command to execute at the scheduled time and day. #> @@ -190,12 +204,16 @@ function Get-CronJob { <# .SYNOPSIS Returns the current cron jobs from the cron table + .DESCRIPTION Returns the current cron jobs from the cron table + .EXAMPLE Get-CronJob -UserName Steve + .RETURNVALUE CronJob objects + .PARAMETER UserName Optional parameter to specify a specific user's cron table #> |