Resource Type: dsc_xwefsubscription

Defined in:

lib/puppet/type/dsc_xwefsubscription.rb

Providers:

powershell

Overview

The DSC xWEFSubscription resource type. Automatically generated from ‘xWindowsEventForwarding/DSCResources/MSFT_xWEFSubscription/MSFT_xWEFSubscription.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
  • absent

Parameters

• dsc_address

  Address - Expects an array of source node FQDNs, default source.wef.test to prevent errors when only staging test subscription

• dsc_allowedsourcedomaincomputers

  AllowedSourceDomainComputers - In Source Initiated scenario this SDDL determines who can push events, default O:NSG:NSD:(A;;GA;;;DC)(A;;GA;;;NS) which equates to Domain Computers and Network Service

• dsc_allowedsourcenondomaincomputers

  AllowedSourceNonDomainComputers - This parameter has not been fully implemented, only required for source initiated scenarios, provide XML to set IssuerCAList, AllowedSubjectList, or DeniedSubjectList if this will be used, default empty string

• dsc_contentformat

  ContentFormat - Format that event logs will be submitted in, default RenderedText

• dsc_credentialstype

  CredentialsType - Sets the credential type used for authenticating to WinRM, default Default Valid values are Default, Basic, Negotiate, Digest.

• dsc_deliverymode

  DeliveryMode - Configures whether the collector will pull events from source nodes or if the source nodes will push events to the collector, default push Valid values are Push, Pull.

• dsc_description

  Description - Description of the Collector subscription

• dsc_enabled

  Enabled - Sets whether the subscription will be enabled, default true Valid values are true, false.

• dsc_ensure

  Ensure - Determines whether to validate or remove the scubscription Valid values are Present, Absent.

• dsc_heartbeatinterval

  HeartBeatInterval - Frequency to verify connectivity, default 20000

• dsc_locale

  Locale - Sets the subscription Locale, default en-US

• dsc_logfile

  LogFile - Sets the event log that the collected events will be written to, default ForwardedEvents

• dsc_maxitems

  MaxItems - The number of events that can occur on the source before they are submitted to the collector, default 1

• dsc_maxlatencytime

  MaxLatencyTime - The maximum amount of time that can pass before events are submitted to the collector, default 20000

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_query

  Query - Expects an array of hashtables that set which events should be collected, default is all application and system logs

• dsc_readexistingevents

  ReadExistingEvents - Should the collector read existing or only new events, default false Valid values are true, false.

• dsc_subscriptionid

  SubscriptionID - Name of the Subscription

• dsc_subscriptiontype

  SubscriptionType - Type of Subscription to create Valid values are CollectorInitiated, SourceInitiated.

• dsc_transportname

  TransportName - Determines whether to require SSL, default HTTP Valid values are HTTP, HTTPS.

• dsc_transportport

  TransportPort - Set the port number that WinRM should use to make a connection, default 5985

• name (namevar)
• provider

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