Resource Type: dsc_xwindowsupdateagent

Defined in:

lib/puppet/type/dsc_xwindowsupdateagent.rb

Providers:

powershell

Overview

The DSC xWindowsUpdateAgent resource type. Automatically generated from ‘xWindowsUpdate/DscResources/MSFT_xWindowsUpdateAgent/MSFT_xWindowsUpdateAgent.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present

Parameters

• dsc_automaticupdatesnotificationsetting

  AutomaticUpdatesNotificationSetting - Automatic Updates Notification Setting

• dsc_category

  Category - Indicates if the resource should ensure all Windows Updates are installed or if Automatic updates should be disabled. Valid values are Security, Important, Optional.

• dsc_issingleinstance

  IsSingleInstance - Specifies the resource is a single instance, the value must be ‘Yes’ Valid values are Yes.

• dsc_notifications

  Notifications - Indicates if Windows update agent should notify about updates, see:msdn.microsoft.com/en-us/library/windows/desktop/aa385806%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396. Valid values are Disabled, ScheduledInstallation.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_rebootrequired

  RebootRequired - Indicates if Wua Requires a reboot. Only returned if UpdateNow is specified.

  Supported values:

  • true
  • false
• dsc_source

  Source - Indicates which source service Windows update agent should use. Note: WSUS is not implemented in this resource. Valid values are WindowsUpdate, MicrosoftUpdate, WSUS.

• dsc_totalupdatesnotinstalled

  TotalUpdatesNotInstalled - Count of updates not installed. Only returned if UpdateNow is specified.

• dsc_updatenow

  UpdateNow - Indicates if the resource should trigger an update during consistency.

  Supported values:

  • true
  • false
• name (namevar)
• provider

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