New in version 2.4.
Parameter | Choices/Defaults | Comments |
---|---|---|
automatic bool |
| Configures AutomaticManagedPagefile for the entire system. |
drive | The drive of the pagefile. | |
initial_size int | The initial size of the pagefile in megabytes. | |
maximum_size int | The maximum size of the pagefile in megabytes. | |
override bool |
| Override the current pagefile on the drive. |
remove_all bool |
| Remove all pagefiles in the system, not including automatic managed. |
state |
| State of the pagefile. |
system_managed bool |
| Configures current pagefile to be managed by the system. |
test_path bool |
| Use Test-Path on the drive to make sure the drive is accessible before creating the pagefile. |
Note
- name: Query pagefiles configuration win_pagefile: - name: Query C pagefile win_pagefile: drive: C - name: Set C pagefile, don't override if exists win_pagefile: drive: C initial_size: 1024 maximum_size: 1024 override: no state: present - name: Set C pagefile, override if exists win_pagefile: drive: C initial_size: 1024 maximum_size: 1024 state: present - name: Remove C pagefile win_pagefile: drive: C state: absent - name: Remove all current pagefiles, enable AutomaticManagedPagefile and query at the end win_pagefile: remove_all: yes automatic: yes - name: Remove all pagefiles disable AutomaticManagedPagefile and set C pagefile win_pagefile: drive: C initial_size: 2048 maximum_size: 2048 remove_all: yes automatic: no state: present - name: Set D pagefile, override if exists win_pagefile: drive: d initial_size: 1024 maximum_size: 1024 state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
automatic_managed_pagefiles boolean | When state is query. | Whether the pagefiles is automatically managed. Sample: True |
pagefiles list | When state is query. | Contains caption, description, initial_size, maximum_size and name for each pagefile in the system. Sample: [{'caption': "c:\\ 'pagefile.sys'", 'maximum_size': 2048, 'initial_size': 2048, 'description': "'pagefile.sys' @ c:\\", 'name': 'c:\\pagefile.sys'}, {'caption': "d:\\ 'pagefile.sys'", 'maximum_size': 1024, 'initial_size': 1024, 'description': "'pagefile.sys' @ d:\\", 'name': 'd:\\pagefile.sys'}] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/win_pagefile_module.html