Downloads:

457

Downloads of v 1.1.0:

457

Last Update:

2/8/2016

Package Maintainer(s):

Software Author(s):

  • DarwinJS

Tags:

scheduled-shutdown admin ChocolateyDesignPatterns

Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs)

1.1.0 | Updated: 2/8/2016

Downloads:

457

Downloads of v 1.1.0:

457

Maintainer(s):

Software Author(s):

  • DarwinJS

Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs) 1.1.0

All Checks are Passing

2 Passing Test


Validation Testing Passed


Verification Testing Passed

Details

To install Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs), run the following command from the command line or from PowerShell:

>

To upgrade Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs), run the following command from the command line or from PowerShell:

>

To uninstall Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs), run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade scheduled-shutdown -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade scheduled-shutdown -y --source="'STEP 3 URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure scheduled-shutdown installed
  win_chocolatey:
    name: scheduled-shutdown
    state: present
    version: 1.1.0
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'scheduled-shutdown' do
  action    :install
  version  '1.1.0'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: scheduled-shutdown,
    Version: 1.1.0,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller scheduled-shutdown
{
   Name     = 'scheduled-shutdown'
   Ensure   = 'Present'
   Version  = '1.1.0'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'scheduled-shutdown':
  provider => 'chocolatey',
  ensure   => '1.1.0',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install scheduled-shutdown version="1.1.0" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator ferventcoder on 2/8/2016.

Description

Schedule Nightly or Weekend Shutdown of Windows (Usually for Test VMs)


Tools\ChocolateyInstall.ps1

$packageid = "Scheduled-Shutdown"
$ShutdownTime = '23:50' #Hour in 24hr / min format
$Frequency = 'Daily' #Daily or Weekly
$Weekday = 'FRI'
$Modifier  = $null

$arguments = @{};
$packageParameters = $env:chocolateyPackageParameters;

# Now parse the packageParameters using good old regular expression
if ($packageParameters) {
    $match_pattern = "\/(?<option>([a-zA-Z]+)):(?<value>([`"'])?([a-zA-Z0-9- _\\:\.]+)([`"'])?)|\/(?<option>([a-zA-Z]+))"
    #"
    $option_name = 'option'
    $value_name = 'value'

    if ($packageParameters -match $match_pattern ){
        $results = $packageParameters | Select-String $match_pattern -AllMatches
        $results.matches | % {
          $arguments.Add(
              $_.Groups[$option_name].Value.Trim(),
              $_.Groups[$value_name].Value.Trim())
      }
    }
    else
    {
      throw "Package Parameters were found but were invalid (REGEX Failure)"
    }
    if ($arguments.ContainsKey("ShutdownTime")) {
        Write-Output "ShutdownTime argument used, changing from default $Shutdown time to $($arguments.Get_Item("ShutdownTime"))"
        $ShutdownTime = $arguments.Get_Item("ShutdownTime")
    }
    if ($arguments.ContainsKey("Frequency")) {
        Write-Output "Frequency argument used, changing from default $Frequency time to $($arguments.Get_Item("Frequency"))"
        $Frequency = $arguments["Frequency"]
    }
    if ($arguments.ContainsKey("Weekday")) {
      If ($Frequency -ieq 'Daily')
        {
          Write-Ouput "Ignoring Weekday argument set to $Weekday because Frequency is set to $Frequency (you must set Frequency to Weekly for Weekday to be relevant)"
        }
        else
        {
          Write-Output "Weekday argument used, changing from default $Weekday time to $($arguments.Get_Item("Weekday"))"
          $Weekday = $arguments["Weekday"]
        }
    }
} else {
    Write-Debug "No Package Parameters Passed in, using defaults.";
}

If ($Frequency -ieq "Weekly")
{
  $modifier = " /MO 1 /D $Weekday "
}


If (Test-Path "$env:windir\System32\Tasks\$packageid")
{
  schtasks /delete /tn "$packageid" /F
}

$argumentstring = "/create /sc `"$Frequency`" /tn `"$packageid`" /ru `"NT AUTHORITY\SYSTEM`" /tr `"c:\windows\system32\shutdown.exe /s /t 120 /c $packageid /f`" /st `"$ShutdownTime`" $modifier"

Write-output "Scheduling with command: "
Write-Output "$argumentstring"

Start-process "schtasks.exe" -ArgumentList "$argumentstring" -nonewwindow -wait

$StatusMessage = "Shutdown is scheduled for $ShutdownTime on a $Frequency Basis"

If ($Frequency -ieq 'Weekly')
{
  $StatusMessage += " every $Weekday."
}

Write-warning "**********************************************************************"
Write-warning "$StatusMessage"
Write-warning "**********************************************************************"

Write-Output "`r`nRerun this package ($packageid) with parameter `"-Force`", to remove shutdown schedule, uninstall this package."
Tools\ChocolateyUninstall.ps1

$packageid = "Scheduled-Shutdown"

If (Test-Path "$env:windir\System32\Tasks\$packageid")
{
  schtasks /delete /tn "$packageid" /F
}

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status

Remove this package to remove the scheduled shutdown.
Rerun this package with -Force to change the schedule.

This package can take the following command line parameters:

-params '"/Frequency:Daily"' (Default: Daily, Options: 'Daily','Weekly')
-params '"/ShutdownTime:23:50"' (Default: 23:50, Options: 24Hr Format)
-params '"/Weekday:FRI"' (Default: FRI, Options: MON,TUE,WED,THU,FRI,SAT,SUN)
     THIS OPTION IS IGNORED when Frequency=Daily

Examples:
-params '"/Frequency:Weekly"'
  Shutdown weekly on Friday at 23:50 (defaults used for Weekday and ShutdownTime)
-params '"/ShutdownTime:22:00"'
  Shutdown Daily at 22:00 (defaults used for Frequency)
-params '"/Frequency:Weekly /ShutdownTime:22:30 /Weekday:TUE"'
  Shutown weekly on Tuesday at 22:30

This package has no dependencies.

Discussion for the Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs) Package

Ground Rules:

  • This discussion is only about Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs) and the Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs) package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Schedule Nightly or Weekend Shutdown of Windows (Usually for VMs), or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus