Skip to content

Commit

Permalink
Release version 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Auto-release committed Aug 24, 2020
1 parent 51d5150 commit a88748a
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 53 deletions.
21 changes: 19 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,31 @@

All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).

## [v2.1.0](https://github.com/puppetlabs/puppetlabs-scheduled_task/tree/v2.0.1) (2020-07-24)
## [v2.2.0](https://github.com/puppetlabs/puppetlabs-scheduled_task/tree/v2.2.0) (2020-08-24)

[Full Changelog](https://github.com/puppetlabs/puppetlabs-scheduled_task/compare/v2.0.1...v2.0.1)
[Full Changelog](https://github.com/puppetlabs/puppetlabs-scheduled_task/compare/v2.1.0...v2.2.0)

### Added

- pdksync - \(IAC-973\) - Update travis/appveyor to run on new default branch `main` [\#154](https://github.com/puppetlabs/puppetlabs-scheduled_task/pull/154) ([david22swan](https://github.com/david22swan))
- \(IAC-732\) - implement `Run only when user is logged on [\#150](https://github.com/puppetlabs/puppetlabs-scheduled_task/pull/150) ([david22swan](https://github.com/david22swan))

### Fixed

- \(MODULES-10783\) Add back empty? check for `datetime\_string` value [\#158](https://github.com/puppetlabs/puppetlabs-scheduled_task/pull/158) ([sanfrancrisko](https://github.com/sanfrancrisko))

## [v2.1.0](https://github.com/puppetlabs/puppetlabs-scheduled_task/tree/v2.1.0) (2020-07-24)

[Full Changelog](https://github.com/puppetlabs/puppetlabs-scheduled_task/compare/v2.0.1...v2.1.0)

### Added

- \(IAC-918\) - `disable\_time\_zone\_synchronization` function implemented [\#145](https://github.com/puppetlabs/puppetlabs-scheduled_task/pull/145) ([david22swan](https://github.com/david22swan))

### UNCATEGORIZED PRS; LABEL THEM ON GITHUB

- \(IAC-962\) - v2.1.0 Release Prep [\#146](https://github.com/puppetlabs/puppetlabs-scheduled_task/pull/146) ([david22swan](https://github.com/david22swan))

## [v2.0.1](https://github.com/puppetlabs/puppetlabs-scheduled_task/tree/v2.0.1) (2020-02-12)

[Full Changelog](https://github.com/puppetlabs/puppetlabs-scheduled_task/compare/v2.0.0...v2.0.1)
Expand Down
107 changes: 57 additions & 50 deletions REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Resource types**
### Resource types

* [`scheduled_task`](#scheduled_task): Installs and manages Windows Scheduled Tasks.

## Resource types

### scheduled_task
### `scheduled_task`

Installs and manages Windows Scheduled Tasks.

Expand All @@ -20,61 +21,18 @@ of the `trigger` attribute for details on setting schedules."

The following properties are available in the `scheduled_task` type.

##### `ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

##### `enabled`

Valid values: `true`, `false`

Whether the triggers for this task should be enabled. This attribute
affects every trigger for the task; triggers cannot be enabled or
disabled individually.

Default value: true

##### `command`

The full path to the application to run, without any arguments.

##### `working_dir`

The full path of the directory in which to start the command.

##### `arguments`

Any arguments or flags that should be passed to the command. Multiple arguments
should be specified as a space-separated string.

##### `user`

The user to run the scheduled task as. Please note that not
all security configurations will allow running a scheduled task
as 'SYSTEM', and saving the scheduled task under these
conditions will fail with a reported error of 'The operation
completed successfully'. It is recommended that you either
choose another user to run the scheduled task, or alter the
security policy to allow v1 scheduled tasks to run as the
'SYSTEM' account. Defaults to 'SYSTEM'.

Please also note that Puppet must be running as a privileged user
in order to manage `scheduled_task` resources. Running as an
unprivileged user will result in 'access denied' errors.

If a user is specified without an accompanying password, the
task will be created with `Run only when user is logged on`
specified.
##### `command`

Default value: system
The full path to the application to run, without any arguments.

##### `compatibility`

Valid values: 1, 2, 3, 4, 5, 6
Valid values: `1`, `2`, `3`, `4`, `5`, `6`

The compatibility level associated with the task. May currently be set
to 1 for compatibility with tasks on a Windows XP or Windows Server
Expand All @@ -84,7 +42,25 @@ and 2008R2, 4 for compatibility with new features for tasks introduced in
Windows 8, Server 2012R2 and Server 2016, or 5 / 6 for compatibility with
new features for tasks introduced in Windows 10

Default value: 1
Default value: `1`

##### `enabled`

Valid values: ``true``, ``false``

Whether the triggers for this task should be enabled. This attribute
affects every trigger for the task; triggers cannot be enabled or
disabled individually.

Default value: `true`

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

##### `trigger`

Expand All @@ -110,7 +86,7 @@ A trigger can contain the following keys:
minutes_interval.
* `disable_time_zone_synchronization` --- Whether or not to disable the
`synchronise across time zones` function. Due to difficulties with the
API this is non idempotent. Defaults to false.
api this is non idempotent. Defaults to false
* For `daily` triggers:
* `every` --- How often the task should run, as a number of days. Defaults
to 1. ("2" means every other day, "3" means every three days, etc.)
Expand Down Expand Up @@ -205,6 +181,31 @@ Examples:
user_id => 'MyDomain\\SomeUser'
}

##### `user`

The user to run the scheduled task as. Please note that not
all security configurations will allow running a scheduled task
as 'SYSTEM', and saving the scheduled task under these
conditions will fail with a reported error of 'The operation
completed successfully'. It is recommended that you either
choose another user to run the scheduled task, or alter the
security policy to allow v1 scheduled tasks to run as the
'SYSTEM' account. Defaults to 'SYSTEM'.

Please also note that Puppet must be running as a privileged user
in order to manage `scheduled_task` resources. Running as an
unprivileged user will result in 'access denied' errors.

If a user is specified without an accompanying password, the
task will be created with `Run only when user is logged on`
specified.

Default value: `system`

##### `working_dir`

The full path of the directory in which to start the command.

#### Parameters

The following parameters are available in the `scheduled_task` type.
Expand All @@ -228,3 +229,9 @@ This is only used if specifying a user other than 'SYSTEM'.
Since there is no way to retrieve the password used to set the
account information for a task, this parameter will not be used
to determine if a scheduled task is in sync or not.

##### `provider`

The specific backend to use for this `scheduled_task` resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.

2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "puppetlabs-scheduled_task",
"version": "2.1.0",
"version": "2.2.0",
"author": "puppetlabs",
"summary": "Manage scheduled tasks for Windows Server 2008 and newer operating systems.",
"license": "Apache-2.0",
Expand Down

0 comments on commit a88748a

Please sign in to comment.