mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 22:00:22 -07:00
Fix parameter types and other fixes (#50111)
* Fix parameter types and other fixes * Fix issues after review * Fix Windows-references in system/files modules This PR includes: - Replacing version/v with just Ansible X.Y - Removing Windows-alternatives from notes * Update lib/ansible/modules/system/parted.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/system/service.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/system/service.py Co-Authored-By: dagwieers <dag@wieers.com> * Revert type change, move to separate PR * Update lib/ansible/modules/files/replace.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/files/replace.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/files/replace.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/files/replace.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/files/replace.py Co-Authored-By: dagwieers <dag@wieers.com> * Update lib/ansible/modules/files/replace.py Co-Authored-By: dagwieers <dag@wieers.com>
This commit is contained in:
Dag Wieers
GitHub
parent
b834b29e43
commit
30227ace98
43 changed files with 1222 additions and 1065 deletions
|
|
@ -27,6 +27,7 @@ options:
|
|||
path:
|
||||
description:
|
||||
- Path to the file being managed.
|
||||
type: path
|
||||
required: yes
|
||||
aliases: [ dest, name ]
|
||||
state:
|
||||
|
|
@ -43,6 +44,7 @@ options:
|
|||
- If C(touch) (new in 1.4), an empty file will be created if the C(path) does not
|
||||
exist, while an existing file or directory will receive updated file access and
|
||||
modification times (similar to the way C(touch) works from the command line).
|
||||
type: str
|
||||
default: file
|
||||
choices: [ absent, directory, file, hard, link, touch ]
|
||||
src:
|
||||
|
|
@ -52,6 +54,7 @@ options:
|
|||
- Will accept absolute, relative and non-existing paths.
|
||||
- Relative paths are relative to the file being created (C(path)) which is how
|
||||
the Unix command C(ln -s SRC DEST) treats relative paths.
|
||||
type: path
|
||||
recurse:
|
||||
description:
|
||||
- Recursively set the specified file attributes on directory contents.
|
||||
|
|
@ -79,11 +82,13 @@ options:
|
|||
- This parameter indicates the time the file's modification time should be set to.
|
||||
- Should be C(preserve) when no modification is required, C(YYYYMMDDHHMM.SS) when using default time format, or C(now).
|
||||
- Default is None meaning that C(preserve) is the default for C(state=[file,directory,link,hard]) and C(now) is default for C(state=touch).
|
||||
type: str
|
||||
version_added: "2.7"
|
||||
modification_time_format:
|
||||
description:
|
||||
- When used with C(modification_time), indicates the time format that must be used.
|
||||
- Based on default Python format (see time.strftime doc).
|
||||
type: str
|
||||
default: "%Y%m%d%H%M.%S"
|
||||
version_added: '2.7'
|
||||
access_time:
|
||||
|
|
@ -91,15 +96,15 @@ options:
|
|||
- This parameter indicates the time the file's access time should be set to.
|
||||
- Should be C(preserve) when no modification is required, C(YYYYMMDDHHMM.SS) when using default time format, or C(now).
|
||||
- Default is C(None) meaning that C(preserve) is the default for C(state=[file,directory,link,hard]) and C(now) is default for C(state=touch).
|
||||
type: str
|
||||
version_added: '2.7'
|
||||
access_time_format:
|
||||
description:
|
||||
- When used with C(access_time), indicates the time format that must be used.
|
||||
- Based on default Python format (see time.strftime doc).
|
||||
type: str
|
||||
default: "%Y%m%d%H%M.%S"
|
||||
version_added: '2.7'
|
||||
notes:
|
||||
- For Windows targets, use the M(win_file) module instead.
|
||||
seealso:
|
||||
- module: assemble
|
||||
- module: copy
|
||||
|
|
@ -111,21 +116,19 @@ author:
|
|||
- Michael DeHaan
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r'''
|
||||
- name: Change file ownership, group and permissions
|
||||
file:
|
||||
path: /etc/foo.conf
|
||||
owner: foo
|
||||
group: foo
|
||||
# When specifying mode using octal numbers, add a leading 0
|
||||
mode: 0644
|
||||
mode: '0644'
|
||||
|
||||
- name: Create an insecure file
|
||||
file:
|
||||
path: /work
|
||||
owner: root
|
||||
group: root
|
||||
# Or use quotes instead
|
||||
mode: '1777'
|
||||
|
||||
- name: Create a symbolic link
|
||||
|
|
@ -169,7 +172,7 @@ EXAMPLES = '''
|
|||
file:
|
||||
path: /etc/some_directory
|
||||
state: directory
|
||||
mode: 0755
|
||||
mode: '0755'
|
||||
|
||||
- name: Update modification and access time of given file
|
||||
file:
|
||||
|
|
@ -178,7 +181,7 @@ EXAMPLES = '''
|
|||
modification_time: now
|
||||
access_time: now
|
||||
'''
|
||||
RETURN = '''
|
||||
RETURN = r'''
|
||||
|
||||
'''
|
||||
|
||||
|
|
@ -817,21 +820,21 @@ def main():
|
|||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
state=dict(choices=['file', 'directory', 'link', 'hard', 'touch', 'absent'], default=None),
|
||||
path=dict(aliases=['dest', 'name'], required=True, type='path'),
|
||||
_original_basename=dict(required=False), # Internal use only, for recursive ops
|
||||
recurse=dict(default=False, type='bool'),
|
||||
force=dict(required=False, default=False, type='bool'), # Note: Should not be in file_common_args in future
|
||||
follow=dict(required=False, default=True, type='bool'), # Note: Different default than file_common_args
|
||||
_diff_peek=dict(default=None), # Internal use only, for internal checks in the action plugins
|
||||
src=dict(required=False, default=None, type='path'), # Note: Should not be in file_common_args in future
|
||||
modification_time=dict(required=False, default=None),
|
||||
modification_time_format=dict(required=False, default='%Y%m%d%H%M.%S'),
|
||||
access_time=dict(required=False, default=None),
|
||||
access_time_format=dict(required=False, default='%Y%m%d%H%M.%S'),
|
||||
state=dict(type='str', choices=['absent', 'directory', 'file', 'hard', 'link', 'touch']),
|
||||
path=dict(type='path', required=True, aliases=['dest', 'name']),
|
||||
_original_basename=dict(type='str'), # Internal use only, for recursive ops
|
||||
recurse=dict(type='bool', default=False),
|
||||
force=dict(type='bool', default=False), # Note: Should not be in file_common_args in future
|
||||
follow=dict(type='bool', default=True), # Note: Different default than file_common_args
|
||||
_diff_peek=dict(type='str'), # Internal use only, for internal checks in the action plugins
|
||||
src=dict(type='path'), # Note: Should not be in file_common_args in future
|
||||
modification_time=dict(type='str'),
|
||||
modification_time_format=dict(type='str', default='%Y%m%d%H%M.%S'),
|
||||
access_time=dict(type='str'),
|
||||
access_time_format=dict(type='str', default='%Y%m%d%H%M.%S'),
|
||||
),
|
||||
add_file_common_args=True,
|
||||
supports_check_mode=True
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
# When we rewrite basic.py, we will do something similar to this on instantiating an AnsibleModule
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue