collection 교체

collection/community/general/plugins/modules/homectl.py

@@ -1,8 +1,9 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# (c) 2022, James Livulpi
-# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (c) 2022, James Livulpi
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
 
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
@@ -16,6 +17,13 @@ short_description: Manage user accounts with systemd-homed
 version_added: 4.4.0
 description:
     - Manages a user's home directory managed by systemd-homed.
+extends_documentation_fragment:
+    - community.general.attributes
+attributes:
+    check_mode:
+        support: full
+    diff_mode:
+        support: none
 options:
     name:
         description:
@@ -29,7 +37,7 @@ options:
             - Homed requires this value to be in cleartext on user creation and updating a user.
             - The module takes the password and generates a password hash in SHA-512 with 10000 rounds of salt generation using crypt.
             - See U(https://systemd.io/USER_RECORD/).
-            - This is required for I(state=present). When an existing user is updated this is checked against the stored hash in homed.
+            - This is required for O(state=present). When an existing user is updated this is checked against the stored hash in homed.
         type: str
     state:
         description:
@@ -47,17 +55,17 @@ options:
     disksize:
         description:
             - The intended home directory disk space.
-            - Human readable value such as C(10G), C(10M), or C(10B).
+            - Human readable value such as V(10G), V(10M), or V(10B).
         type: str
     resize:
         description:
-            - When used with I(disksize) this will attempt to resize the home directory immediately.
+            - When used with O(disksize) this will attempt to resize the home directory immediately.
         default: false
         type: bool
     realname:
         description:
             - The user's real ('human') name.
-            - This can also be used to add a comment to maintain compatability with C(useradd).
+            - This can also be used to add a comment to maintain compatibility with C(useradd).
         aliases: [ 'comment' ]
         type: str
     realm:
@@ -82,7 +90,7 @@ options:
         description:
             - Path to use as home directory for the user.
             - This is the directory the user's home directory is mounted to while the user is logged in.
-            - This is not where the user's data is actually stored, see I(imagepath) for that.
+            - This is not where the user's data is actually stored, see O(imagepath) for that.
             - Only used when a user is first created.
         type: path
     imagepath:
@@ -94,25 +102,25 @@ options:
     uid:
         description:
             - Sets the UID of the user.
-            - If using I(gid) homed requires the value to be the same.
+            - If using O(gid) homed requires the value to be the same.
             - Only used when a user is first created.
         type: int
     gid:
         description:
             - Sets the gid of the user.
-            - If using I(uid) homed requires the value to be the same.
+            - If using O(uid) homed requires the value to be the same.
             - Only used when a user is first created.
         type: int
     mountopts:
         description:
             - String separated by comma each indicating mount options for a users home directory.
-            - Valid options are C(nosuid), C(nodev) or C(noexec).
-            - Homed by default uses C(nodev) and C(nosuid) while C(noexec) is off.
+            - Valid options are V(nosuid), V(nodev) or V(noexec).
+            - Homed by default uses V(nodev) and V(nosuid) while V(noexec) is off.
         type: str
     umask:
         description:
             - Sets the umask for the user's login sessions
-            - Value from C(0000) to C(0777).
+            - Value from V(0000) to V(0777).
         type: int
     memberof:
         description:
@@ -124,13 +132,13 @@ options:
         description:
             - The absolute path to the skeleton directory to populate a new home directory from.
             - This is only used when a home directory is first created.
-            - If not specified homed by default uses C(/etc/skel).
+            - If not specified homed by default uses V(/etc/skel).
         aliases: [ 'skel' ]
         type: path
     shell:
         description:
             - Shell binary to use for terminal logins of given user.
-            - If not specified homed by default uses C(/bin/bash).
+            - If not specified homed by default uses V(/bin/bash).
         type: str
     environment:
         description:
@@ -143,7 +151,7 @@ options:
     timezone:
         description:
             - Preferred timezone to use for the user.
-            - Should be a tzdata compatible location string such as C(America/New_York).
+            - Should be a tzdata compatible location string such as V(America/New_York).
         type: str
     locked:
         description:
@@ -152,7 +160,7 @@ options:
     language:
         description:
             - The preferred language/locale for the user.
-            - This should be in a format compatible with the C($LANG) environment variable.
+            - This should be in a format compatible with the E(LANG) environment variable.
         type: str
     passwordhint:
         description:
@@ -195,7 +203,7 @@ EXAMPLES = '''
     password: myreallysecurepassword1!
     state: present
     disksize: 10G
-    resize: yes
+    resize: true
 
 - name: Remove an existing user 'janet'
   community.general.homectl:
@@ -328,7 +336,7 @@ class Homectl(object):
         cmd = [self.module.get_bin_path('homectl', True)]
         cmd.append('create')
         cmd.append('--identity=-')  # Read the user record from standard input.
-        return(self.module.run_command(cmd, data=record))
+        return self.module.run_command(cmd, data=record)
 
     def _hash_password(self, password):
         method = crypt.METHOD_SHA512
@@ -385,7 +393,7 @@ class Homectl(object):
             user_metadata.pop('status', None)
             # Let last change Usec be updated by homed when command runs.
             user_metadata.pop('lastChangeUSec', None)
-            # Now only change fields that are called on leaving whats currently in the record intact.
+            # Now only change fields that are called on leaving what's currently in the record intact.
             record = user_metadata
 
         record['userName'] = self.name
@@ -431,7 +439,7 @@ class Homectl(object):
             self.result['changed'] = True
 
         if self.disksize:
-            # convert humand readble to bytes
+            # convert human readable to bytes
             if self.disksize != record.get('diskSize'):
                 record['diskSize'] = human_to_bytes(self.disksize)
                 self.result['changed'] = True