Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theohbrothers/scheduledtaskmanagement
A PowerShell module for non-interactive management of Scheduled Tasks.
https://github.com/theohbrothers/scheduledtaskmanagement
automation devops gitsubmodules iac infrastructure-as-code infrastructureascode mmc non-interactive powershell powershell-gallery powershell-module psgallery scheduled-task scheduled-tasks submodule submodules task-scheduler task-scheduling taskscheduler windows-powershell
Last synced: 27 days ago
JSON representation
A PowerShell module for non-interactive management of Scheduled Tasks.
- Host: GitHub
- URL: https://github.com/theohbrothers/scheduledtaskmanagement
- Owner: theohbrothers
- License: apache-2.0
- Created: 2019-11-20T07:12:29.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-08T12:09:06.000Z (2 months ago)
- Last Synced: 2024-09-28T04:21:16.439Z (about 1 month ago)
- Topics: automation, devops, gitsubmodules, iac, infrastructure-as-code, infrastructureascode, mmc, non-interactive, powershell, powershell-gallery, powershell-module, psgallery, scheduled-task, scheduled-tasks, submodule, submodules, task-scheduler, task-scheduling, taskscheduler, windows-powershell
- Language: PowerShell
- Homepage:
- Size: 143 KB
- Stars: 12
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ScheduledTaskManagement
[](https://dev.azure.com/theohbrothers/ScheduledTaskManagement/_build?definitionId=8)
[](https://github.com/theohbrothers/ScheduledTaskManagement/releases)
[](https://www.powershellgallery.com/packages/ScheduledTaskManagement)
## Introduction
A PowerShell module for non-interactive management of Scheduled Tasks.
## Requirements
* **Windows** with [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-windows-powershell).
## Installation
The module can either be [*installed*](#via-install), or [*imported*](#via-import) from a local copy of this git repository.
### via Install
```powershell
# Latest, for the current user
Install-Module -Name ScheduledTaskManagement -Repository PSGallery -Scope CurrentUser -Verbose
# Specific version, for the current user
Install-Module -Name ScheduledTaskManagement -Repository PSGallery -RequiredVersion x.x.x -Scope CurrentUser -Verbose
# Latest, for all users
Install-Module -Name ScheduledTaskManagement -Repository PSGallery -Scope AllUsers -Verbose
```
If prompted to trust the repository, type `Y` and `enter`.
### via Import
```powershell
# Clone the git repository
git clone https://github.com/theohbrothers/ScheduledTaskManagement.git
cd ScheduledTaskManagement\
# Checkout version to use
git checkout vx.x.x
# Import the module
Import-Module .\src\ScheduledTaskManagement\ScheduledTaskManagement.psm1 -Force -Verbose
```
The module is now ready for use.
## Usage
### Scheduled tasks
To create or apply scheduled tasks, first define the properties of each task in `.ps1` or `.json` definition file(s). Then feed definition file path(s), definition directory path(s), or definition objects to `Setup-ScheduledTask` to create or apply them non-interactively.
The properties of definition objects are based off the parameters of the following cmdlets from the [`ScheduledTasks`](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks) module:
* [`New-ScheduledTaskTrigger`](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtasktrigger)
* [`New-ScheduledTaskAction`](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtaskaction)
* [`New-ScheduledTaskSettingsSet`](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtasksettingsset)
* [`New-ScheduledTaskPrincipal`](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtaskprincipal)
Several parameters such as [`-At`](https://learn.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtasktrigger#-at) of `New-ScheduledTaskTrigger` involve values whose types prevent them from being expressed purely in non-PowerShell code. The module accounts for such values by enabling them to be intuitively yet declaratively defined even in [`.json`](docs/samples/definitions/scheduledtasks/tasks.sample.json#L49-L61) format. Those values will be *converted* into their relevant PowerShell types as part of a [serialization process](src/ScheduledTaskManagement/Private/Serialize-DefinitionObject.ps1#L19-L27) right before task creation or application. Through so, scheduled tasks can be managed as code as part of the practice of [Infrastructure-as-Code (IaC)](https://en.wikipedia.org/wiki/Infrastructure_as_code).
Sample definition files can be found [here](docs/samples/definitions/scheduledtasks).
### Functions
#### Parameters
```powershell
Setup-ScheduledTask -DefinitionFile [-AsJson] []
Setup-ScheduledTask -DefinitionDirectory [-AsJson] []
Setup-ScheduledTask -DefinitionObject []
```
#### Examples
```powershell
# Via .ps1 definition file
Setup-ScheduledTask -DefinitionFile "C:\path\to\definition.ps1"
# Via .json definition file
Setup-ScheduledTask -DefinitionFile "C:\path\to\definition.json" -AsJson
# Via directory containing .ps1 definition file(s)
Setup-ScheduledTask -DefinitionDirectory "C:\path\to\definition\directory\"
# Via directory containing .json definition file(s)
Setup-ScheduledTask -DefinitionDirectory "C:\path\to\definition\directory\" -AsJson
# Via definition object(s)
$tasks = . "C:\path\to\definition.ps1" # From .ps1 definition file
$tasks = Get-Content "C:\path\to\definition.json" | ConvertFrom-Json | % { $_ } # From .json definition file
$tasks = Get-ChildItem "C:\path\to\definition\directory\" -File | ? { $_.Extension -eq '.ps1' } | % { . $_.FullName } # From directory containing .ps1 definition file(s)
$tasks = Get-ChildItem "C:\path\to\definition\directory\" -File | ? { $_.Extension -eq '.json' } | % { Get-Content $_.FullName | ConvertFrom-Json | % { $_ } } # From directory containing .json definition file(s)
## Via parameter
Setup-ScheduledTask -DefinitionObject $tasks
## Via pipeline
$tasks | Setup-ScheduledTask
```
To list all available functions of the module:
```powershell
Get-Command -Module ScheduledTaskManagement
```
## Administration
### Versions
To list versions of the module on `PSGallery`:
```powershell
# Latest
Find-Module -Name ScheduledTaskManagement -Repository PSGallery -Verbose
# All versions
Find-Module -Name ScheduledTaskManagement -Repository PSGallery -AllVersions -Verbose
```
To update the module (**Existing versions are left intact**):
```powershell
# Latest
Update-Module -Name ScheduledTaskManagement -Verbose
# Specific version
Update-Module -Name ScheduledTaskManagement -RequiredVersion x.x.x -Verbose
```
To uninstall the module:
```powershell
# Latest
Uninstall-Module -Name ScheduledTaskManagement -Verbose
# All versions
Uninstall-Module -Name ScheduledTaskManagement -AllVersions -Verbose
# To uninstall all other versions other than x.x.x
Get-Module -Name ScheduledTaskManagement -ListAvailable | ? { $_.Version -ne 'x.x.x' } | % { Uninstall-Module -Name $_.Name -RequiredVersion $_.Version -Verbose }
# Tip: Simulate uninstalls with -WhatIf
```
### Repositories
To get all registered PowerShell repositories:
```powershell
Get-PSRepository -Verbose
```
To set the installation policy for the `PSGallery` repository:
```powershell
# PSGallery (trusted)
Set-PSRepository -Name PSGallery -InstallationPolicy Trusted -Verbose
# PSGallery (untrusted)
Set-PSRepository -Name PSGallery -InstallationPolicy Untrusted -Verbose
```
### Development
To import / re-import the module:
```powershell
# Installed version
Import-Module -Name ScheduledTaskManagement -Force -Verbose
# Project version
Import-Module .\src\ScheduledTaskManagement\ScheduledTaskManagement.psm1 -Force -Verbose
```
To remove imported functions of the module:
```powershell
Remove-Module -Name ScheduledTaskManagement -Verbose
```
To list imported versions of the module:
```powershell
Get-Module -Name ScheduledTaskManagement
```
To list all installed versions of the module available for import:
```powershell
Get-Module -Name ScheduledTaskManagement -ListAvailable -Verbose
```