windows_pagefile resource¶
Use the windows_pagefile resource to configure pagefile settings on Windows.
New in Chef Client 14.0.
Syntax¶
The windows_pagefile resource has the following syntax:
windows_pagefile 'name' do
automatic_managed true, false # default value: false
initial_size Integer
maximum_size Integer
path String # default value: 'name' unless specified
system_managed true, false
action Symbol # defaults to :set if not specified
end
where:
windows_pagefile
is the resource.name
is the name given to the resource block.action
identifies which steps the chef-client will take to bring the node into the desired state.automatic_managed
,initial_size
,maximum_size
,path
, andsystem_managed
are the properties available to this resource.
Actions¶
The windows_pagefile resource has the following actions:
:set
- Default. Configures the default pagefile, creating if it doesn’t exist.
:delete
- Deletes the specified pagefile.
:nothing
- Define this resource block to do nothing until notified by another resource to take action. When this resource is notified, this resource block is either run immediately or it is queued up to be run at the end of the Chef Client run.
Properties¶
The windows_pagefile resource has the following properties:
automatic_managed
Ruby Type: true, false | Default Value:
false
Enable automatic management of pagefile initial and maximum size. Setting this to true ignores ‘initial_size’ and ‘maximum_size’ properties.
initial_size
Ruby Type: Integer
Initial size of the pagefile in megabytes.
maximum_size
Ruby Type: Integer
Maximum size of the pagefile in megabytes.
notifies
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may notify another resource to take action when its state changes. Specify a
'resource[name]'
, the:action
that resource should take, and then the:timer
for that action. A resource may notify more than one resource; use anotifies
statement for each resource to be notified.A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:
:before
- Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
- Default. Specifies that a notification should be queued up, and then executed at the end of the Chef Client run.
:immediate
,:immediately
- Specifies that a notification should be run immediately, per resource notified.
The syntax for
notifies
is:notifies :action, 'resource[name]', :timer
path
Ruby Type: String | Default Value:
'name'
The path to the pagefile if different from the resource name.
subscribes
Ruby Type: Symbol, ‘Chef::Resource[String]’
A resource may listen to another resource, and then take action if the state of the resource being listened to changes. Specify a
'resource[name]'
, the:action
to be taken, and then the:timer
for that action.Note that
subscribes
does not apply the specified action to the resource that it listens to - for example:file '/etc/nginx/ssl/example.crt' do mode '0600' owner 'root' end service 'nginx' do subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately end
In this case the
subscribes
property reloads thenginx
service whenever its certificate file, located under/etc/nginx/ssl/example.crt
, is updated.subscribes
does not make any changes to the certificate file itself, it merely listens for a change to the file, and executes the:reload
action for its resource (in this examplenginx
) when a change is detected.A timer specifies the point during the Chef Client run at which a notification is run. The following timers are available:
:before
- Specifies that the action on a notified resource should be run before processing the resource block in which the notification is located.
:delayed
- Default. Specifies that a notification should be queued up, and then executed at the end of the Chef Client run.
:immediate
,:immediately
- Specifies that a notification should be run immediately, per resource notified.
The syntax for
subscribes
is:subscribes :action, 'resource[name]', :timer
system_managed
Ruby Type: true, false
Configures whether the system manages the pagefile size.