REFERENCE.md

Reference

Table of Contents

Classes

• wsusserver
• wsusserver::built_in_computer_target_groups
• wsusserver::config: Class: wsusserver::config
• wsusserver::install: Class: wsusserver::install
• wsusserver::params: Class: wsusserver::params
• wsusserver::service: Class: wsusserver::service

Defined types

• wsusserver::approvalrule: Define: wsusserver::approvalrule Parameters:

Resource types

• wsusserver_computer_target_group: Creates computer target groups for wsusserver.

Classes

wsusserver

The wsusserver class.

Parameters

The following parameters are available in the wsusserver class:

• update_languages
• update_classifications
• package_ensure
• include_management_console
• trigger_full_synchronization_post_install
• service_manage
• service_ensure
• service_enable
• wsus_directory
• join_improvement_program
• sync_from_microsoft_update
• upstream_wsus_server_name
• upstream_wsus_server_port
• upstream_wsus_server_use_ssl
• targeting_mode
• host_binaries_on_microsoft_update
• synchronize_automatically
• synchronize_time_of_day
• number_of_synchronizations_per_day
• send_sync_notification
• sync_notification_recipients
• send_status_notification
• status_notification_recipients
• notification_frequency
• notification_time_of_day
• smtp_hostname
• smtp_port
• smtp_requires_authentication
• smtp_username
• smtp_password
• smtp_sender_displayname
• smtp_sender_emailaddress
• email_language
• products
• product_families

update_languages

Data type: Array[String, 1]

update_classifications

Data type: Array[String, 1]

package_ensure

Data type: Enum['present', 'absent']

Default value: $wsusserver::params::package_ensure

include_management_console

Data type: Boolean

Default value: $wsusserver::params::include_management_console

trigger_full_synchronization_post_install

Data type: Boolean

Default value: $wsusserver::params::trigger_full_synchronization_post_install

service_manage

Data type: Boolean

Default value: $wsusserver::params::service_manage

service_ensure

Data type: Enum['running', 'stopped']

Default value: $wsusserver::params::service_ensure

service_enable

Data type: Variant[ Boolean, Enum['manual'] ]

Default value: $wsusserver::params::service_enable

wsus_directory

Data type: Stdlib::Absolutepath

Default value: $wsusserver::params::wsus_directory

join_improvement_program

Data type: Boolean

Default value: $wsusserver::params::join_improvement_program

sync_from_microsoft_update

Data type: Boolean

Default value: $wsusserver::params::sync_from_microsoft_update

upstream_wsus_server_name

Data type: Optional[String]

Default value: $wsusserver::params::upstream_wsus_server_name

upstream_wsus_server_port

Data type: Integer

Default value: $wsusserver::params::upstream_wsus_server_port

upstream_wsus_server_use_ssl

Data type: Boolean

Default value: $wsusserver::params::upstream_wsus_server_use_ssl

targeting_mode

Data type: Enum['Server', 'Client']

Default value: $wsusserver::params::targeting_mode

host_binaries_on_microsoft_update

Data type: Boolean

Default value: $wsusserver::params::host_binaries_on_microsoft_update

synchronize_automatically

Data type: Boolean

Default value: $wsusserver::params::synchronize_automatically

synchronize_time_of_day

Data type: String

Default value: $wsusserver::params::synchronize_time_of_day

number_of_synchronizations_per_day

Data type: Integer

Default value: $wsusserver::params::number_of_synchronizations_per_day

send_sync_notification

Data type: Boolean

Default value: $wsusserver::params::send_sync_notification

sync_notification_recipients

Data type: Array[String, 1]

Default value: $wsusserver::params::sync_notification_recipients

send_status_notification

Data type: Boolean

Default value: $wsusserver::params::send_status_notification

status_notification_recipients

Data type: Array[String, 1]

Default value: $wsusserver::params::status_notification_recipients

notification_frequency

Data type: Enum['Weekly', 'Daily']

Default value: $wsusserver::params::notification_frequency

notification_time_of_day

Data type: String

Default value: $wsusserver::params::notification_time_of_day

smtp_hostname

Data type: String

Default value: $wsusserver::params::smtp_hostname

smtp_port

Data type: Integer

Default value: $wsusserver::params::smtp_port

smtp_requires_authentication

Data type: Boolean

Default value: $wsusserver::params::smtp_requires_authentication

smtp_username

Data type: String

Default value: $wsusserver::params::smtp_username

smtp_password

Data type: String

Default value: $wsusserver::params::smtp_password

smtp_sender_displayname

Data type: String

Default value: $wsusserver::params::smtp_sender_displayname

smtp_sender_emailaddress

Data type: String

Default value: $wsusserver::params::smtp_sender_emailaddress

email_language

Data type: String

Default value: $wsusserver::params::email_language

products

Data type: Variant[ Enum['*'], Array[String] ]

Default value: []

product_families

Data type: Array[String]

Default value: []

wsusserver::built_in_computer_target_groups

The wsusserver::built_in_computer_target_groups class.

wsusserver::config

Class: wsusserver::config

Parameters

The following parameters are available in the wsusserver::config class:

• update_languages
• products
• product_families
• update_classifications
• join_improvement_program
• sync_from_microsoft_update
• upstream_wsus_server_name
• upstream_wsus_server_port
• upstream_wsus_server_use_ssl
• targeting_mode
• host_binaries_on_microsoft_update
• synchronize_automatically
• synchronize_time_of_day
• number_of_synchronizations_per_day
• trigger_full_synchronization_post_install
• send_sync_notification
• sync_notification_recipients
• send_status_notification
• status_notification_recipients
• notification_frequency
• notification_time_of_day
• smtp_hostname
• smtp_port
• smtp_requires_authentication
• smtp_username
• smtp_password
• smtp_sender_displayname
• smtp_sender_emailaddress
• email_language

update_languages

Data type: Array[String, 1]

products

Data type: Array[String, 0]

product_families

Data type: Optional[Array[String]]

update_classifications

Data type: Array[String, 1]

join_improvement_program

Data type: Boolean

Default value: $wsusserver::params::join_improvement_program

sync_from_microsoft_update

Data type: Boolean

Default value: $wsusserver::params::sync_from_microsoft_update

upstream_wsus_server_name

Data type: Optional[String]

Default value: $wsusserver::params::upstream_wsus_server_name

upstream_wsus_server_port

Data type: Integer

Default value: $wsusserver::params::upstream_wsus_server_port

upstream_wsus_server_use_ssl

Data type: Boolean

Default value: $wsusserver::params::upstream_wsus_server_use_ssl

targeting_mode

Data type: Enum['Server', 'Client']

Default value: $wsusserver::params::targeting_mode

host_binaries_on_microsoft_update

Data type: Boolean

Default value: $wsusserver::params::host_binaries_on_microsoft_update

synchronize_automatically

Data type: Boolean

Default value: $wsusserver::params::synchronize_automatically

synchronize_time_of_day

Data type: String

Default value: $wsusserver::params::synchronize_time_of_day

number_of_synchronizations_per_day

Data type: Integer

Default value: $wsusserver::params::number_of_synchronizations_per_day

trigger_full_synchronization_post_install

Data type: Boolean

Default value: $wsusserver::params::trigger_full_synchronization_post_install

send_sync_notification

Data type: Boolean

Default value: $wsusserver::params::send_sync_notification

sync_notification_recipients

Data type: Array[String, 1]

Default value: $wsusserver::params::sync_notification_recipients

send_status_notification

Data type: Boolean

Default value: $wsusserver::params::send_status_notification

status_notification_recipients

Data type: Array[String, 1]

Default value: $wsusserver::params::status_notification_recipients

notification_frequency

Data type: Enum['Weekly', 'Daily']

Default value: $wsusserver::params::notification_frequency

notification_time_of_day

Data type: String

Default value: $wsusserver::params::notification_time_of_day

smtp_hostname

Data type: String

Default value: $wsusserver::params::smtp_hostname

smtp_port

Data type: Integer

Default value: $wsusserver::params::smtp_port

smtp_requires_authentication

Data type: Boolean

Default value: $wsusserver::params::smtp_requires_authentication

smtp_username

Data type: String

Default value: $wsusserver::params::smtp_username

smtp_password

Data type: String

Default value: $wsusserver::params::smtp_password

smtp_sender_displayname

Data type: String

Default value: $wsusserver::params::smtp_sender_displayname

smtp_sender_emailaddress

Data type: String

Default value: $wsusserver::params::smtp_sender_emailaddress

email_language

Data type: String

Default value: $wsusserver::params::email_language

wsusserver::install

Class: wsusserver::install

Parameters

The following parameters are available in the wsusserver::install class:

• package_ensure
• include_management_console
• wsus_directory
• join_improvement_program

package_ensure

Data type: Enum['present', 'absent']

Default value: $wsusserver::params::package_ensure

include_management_console

Data type: Boolean

Default value: $wsusserver::params::include_management_console

wsus_directory

Data type: Stdlib::Absolutepath

Default value: $wsusserver::params::wsus_directory

join_improvement_program

Data type: Boolean

Default value: $wsusserver::params::join_improvement_program

wsusserver::params

Class: wsusserver::params

wsusserver::service

Class: wsusserver::service

Parameters

The following parameters are available in the wsusserver::service class:

• service_manage
• service_ensure
• service_enable

service_manage

Data type: Boolean

Default value: $wsusserver::params::service_manage

service_ensure

Data type: Enum['running', 'stopped']

Default value: $wsusserver::params::service_ensure

service_enable

Data type: Variant[ Boolean, Enum['manual'] ]

Default value: $wsusserver::params::service_enable

Defined types

wsusserver::approvalrule

Define: wsusserver::approvalrule Parameters:

Parameters

The following parameters are available in the wsusserver::approvalrule defined type:

• classifications
• products
• computer_groups
• rule_name
• ensure
• enabled

classifications

Data type: Array[String]

products

Data type: Array[String]

computer_groups

Data type: Array[String]

rule_name

Data type: String

Default value: $title

ensure

Data type: Enum['present', 'absent']

Default value: 'present'

enabled

Data type: Boolean

Default value: true

Resource types

wsusserver_computer_target_group

Creates computer target groups for wsusserver.

Properties

The following properties are available in the wsusserver_computer_target_group type.

ensure

Valid values: present, absent

Specifies whether the computer target group should be present or absent.

Default value: present

id

The auto-generated id of the computer target group. This property is read-only.

Parameters

The following parameters are available in the wsusserver_computer_target_group type.

• name
• provider

name

namevar

The name of the computer target group.

provider

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