Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.parted.
parted command line tool. For a full description of the fields and the options check the GNU parted manual.The below requirements are needed on the host that executes this module.
/sys/.| Parameter | Choices/Defaults | Comments |
|---|---|---|
| align string |
| Set alignment for newly created partitions. Use 'undefined' for parted default aligment. |
| device string / required | The block device (disk) where to operate. | |
| flags list / elements=string | A list of the flags that has to be set on the partition. | |
| fs_type string added in 0.2.0 of community.general | If specified and the partition does not exist, will set filesystem type to given partition. Parameter optional, but see notes below about negative part_start values. | |
| label string |
| Disk label type to use. If device already contains different label, it will be changed to label and any previous partitions will be lost. |
| name string | Sets the name for the partition number (GPT, Mac, MIPS and PC98 only). | |
| number integer | The number of the partition to work with or the number of the partition that will be created. Required when performing any action on the disk, except fetching information. | |
| part_end string | Default: "100%" | Where the partition will end as offset from the beginning of the disk, that is, the "distance" from the start of the disk. Negative numbers specify distance from the end of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, e.g. 10GiB, 15%. |
| part_start string | Default: "0%" | Where the partition will start as offset from the beginning of the disk, that is, the "distance" from the start of the disk. Negative numbers specify distance from the end of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, e.g. 10GiB, 15%.Using negative values may require setting of fs_type (see notes). |
| part_type string |
| May be specified only with 'msdos' or 'dvh' partition tables. A name must be specified for a 'gpt' partition table.Neither part_type nor name may be used with a 'sun' partition table. |
| resize boolean added in 1.3.0 of community.general |
| Call resizepart on existing partitions to match the size specified by part_end. |
| state string |
| Whether to create or delete a partition. If set to info the module will only return the device information. |
| unit string |
| Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret those given by the user if they are not suffixed by an unit. When fetching information about a disk, it is always recommended to specify a unit. |
Note
/sys/ to obtain disk information. In this case the units CHS and CYL are not supported.part_start start values were rejected if fs_type was not given. This bug was fixed in parted 3.2.153. If you want to use negative part_start, specify fs_type as well or make sure your system contains newer parted.- name: Create a new ext4 primary partition
community.general.parted:
device: /dev/sdb
number: 1
state: present
fs_type: ext4
- name: Remove partition number 1
community.general.parted:
device: /dev/sdb
number: 1
state: absent
- name: Create a new primary partition with a size of 1GiB
community.general.parted:
device: /dev/sdb
number: 1
state: present
part_end: 1GiB
- name: Create a new primary partition for LVM
community.general.parted:
device: /dev/sdb
number: 2
flags: [ lvm ]
state: present
part_start: 1GiB
- name: Create a new primary partition with a size of 1GiB at disk's end
community.general.parted:
device: /dev/sdb
number: 3
state: present
fs_type: ext3
part_start: -1GiB
# Example on how to read info and reuse it in subsequent task
- name: Read device information (always use unit when probing)
community.general.parted: device=/dev/sdb unit=MiB
register: sdb_info
- name: Remove all partitions from disk
community.general.parted:
device: /dev/sdb
number: '{{ item.num }}'
state: absent
loop: '{{ sdb_info.partitions }}'
- name: Extend an existing partition to fill all available space
community.general.parted:
device: /dev/sdb
number: "{{ sdb_info.partitions | length }}"
part_end: "100%"
resize: true
state: present
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| partition_info complex | success | Current partition information Sample: {'disk': {'dev': '/dev/sdb', 'logical_block': 512, 'model': 'VMware Virtual disk', 'physical_block': 512, 'size': 5.0, 'table': 'msdos', 'unit': 'gib'}, 'partitions': [{'begin': 0.0, 'end': 1.0, 'flags': ['boot', 'lvm'], 'fstype': '', 'name': '', 'num': 1, 'size': 1.0}, {'begin': 1.0, 'end': 5.0, 'flags': [], 'fstype': '', 'name': '', 'num': 2, 'size': 4.0}], 'script': 'unit KiB print '} | |
| disk dictionary | success | Generic device information. | |
| partitions list / elements=string | success | List of device partitions. | |
| script string | success | parted script executed by module | |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/parted_module.html