vdo: add force option (#2110) (#2123)

* vdo: add force option * Add changelog * Improve the diff the next time something is added :) Co-authored-by: Felix Fontein <[email protected]> * Add warning text placeholder by felixfontein Co-authored-by: Felix Fontein <[email protected]> * Add warning text * Apply suggestion for warning text from rhawalsh Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 73bb0f1) Co-authored-by: Amin Vakil <[email protected]>
ansible-collections · Mar 27, 2021 · 0d28bfb · 0d28bfb
1 parent ef304ed
commit 0d28bfb
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/changelogs/fragments/2110-vdo-add_force_option.yaml b/changelogs/fragments/2110-vdo-add_force_option.yaml
@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - vdo - add ``force`` option (https://github.com/ansible-collections/community.general/issues/2101).
diff --git a/plugins/modules/system/vdo.py b/plugins/modules/system/vdo.py
@@ -258,6 +258,18 @@
               configured setting unless a different value is specified
               in the playbook.
         type: str
+    force:
+        description:
+            - When creating a volume, ignores any existing file system
+              or VDO signature already present in the storage device.
+              When stopping or removing a VDO volume, first unmounts
+              the file system stored on the device if mounted.
+            - "B(Warning:) Since this parameter removes all safety
+              checks it is important to make sure that all parameters
+              provided are accurate and intentional."
+        type: bool
+        default: no
+        version_added: 2.4.0
 notes:
   - In general, the default thread configuration should be used.
 requirements:
@@ -409,6 +421,9 @@ def add_vdooptions(params):
     if ('indexmode' in params) and (params['indexmode'] == 'sparse'):
         options.append("--sparseIndex=enabled")
 
+    if ('force' in params) and (params['force']):
+        options.append("--force")
+
     # Entering an invalid thread config results in a cryptic
     # 'Could not set up device mapper for %s' error from the 'vdo'
     # command execution.  The dmsetup module on the system will
@@ -465,7 +480,8 @@ def run_module():
         biothreads=dict(type='str'),
         cputhreads=dict(type='str'),
         logicalthreads=dict(type='str'),
-        physicalthreads=dict(type='str')
+        physicalthreads=dict(type='str'),
+        force=dict(type='bool', default=False),
     )
 
     # Seed the result dictionary in the object.  There will be an