internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 22:02:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Convert to reduced list of known types (#50010)

Browse Source
This commit is contained in:
Dag Wieers
2018-12-18 22:25:30 +01:00
committed by Jordan Borean
parent fcd1486b51
commit 05c6ff79f9
908 changed files with 4822 additions and 4821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
lib/ansible/modules/windows/win_audit_policy_system.py
View File

@@ -63,7 +63,7 @@ RETURN = '''
current_audit_policy:
description: details on the policy being targetted
returned: always
type: dictionary
type: dict
sample: |-
{
"File Share":"failure"

4
lib/ansible/modules/windows/win_audit_rule.py
View File

@@ -121,7 +121,7 @@ current_audit_rules:
- The current rules on the defined I(path)
- Will return "No audit rules defined on I(path)"
returned: always
type: dictionary
type: dict
sample: |
{
"audit_flags": "Success",
@@ -136,5 +136,5 @@ path_type:
- The type of I(path) being targetted.
- Will be one of file, directory, registry.
returned: always
type: string
type: str
'''

12
lib/ansible/modules/windows/win_chocolatey_facts.py
View File

@@ -99,7 +99,7 @@ ansible_facts:
certificate:
description: Pth to a PFX certificate for X509 authenticated feeds
returned: always
type: string
type: str
sample: C:\chocolatey\cert.pfx
disabled:
description: Is the source disabled
@@ -109,7 +109,7 @@ ansible_facts:
name:
description: Name of the source
returned: always
type: string
type: str
sample: chocolatey
priority:
description: The priority order of this source, lower is better, 0 is no priority
@@ -119,12 +119,12 @@ ansible_facts:
source:
description: The source, can be a folder/file or an url
returned: always
type: string
type: str
sample: https://chocolatey.org/api/v2/
source_username:
description: Username used to access authenticated feeds
returned: always
type: string
type: str
sample: username
packages:
description: List of installed Packages
@@ -134,11 +134,11 @@ ansible_facts:
package:
description: Name of the package
returned: always
type: string
type: str
sample: vscode
version:
description: Version of the package
returned: always
type: string
type: str
sample: '1.27.2'
'''

14
lib/ansible/modules/windows/win_command.py
View File

@@ -81,37 +81,37 @@ RETURN = r'''
msg:
description: changed
returned: always
type: boolean
type: bool
sample: True
start:
description: The command execution start time
returned: always
type: string
type: str
sample: '2016-02-25 09:18:26.429568'
end:
description: The command execution end time
returned: always
type: string
type: str
sample: '2016-02-25 09:18:26.755339'
delta:
description: The command execution delta time
returned: always
type: string
type: str
sample: '0:00:00.325771'
stdout:
description: The command standard output
returned: always
type: string
type: str
sample: 'Clustering node rabbit@slave1 with rabbit@master ...'
stderr:
description: The command standard error
returned: always
type: string
type: str
sample: 'ls: cannot access foo: No such file or directory'
cmd:
description: The command executed by the task
returned: always
type: string
type: str
sample: 'rabbitmqctl join_cluster rabbit@master'
rc:
description: The command return code (0 means success)

10
lib/ansible/modules/windows/win_copy.py
View File

@@ -143,17 +143,17 @@ RETURN = r'''
dest:
description: destination file/path
returned: changed
type: string
type: str
sample: C:\Temp\
src:
description: source file used for the copy on the target machine
returned: changed
type: string
type: str
sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source
checksum:
description: sha1 checksum of the file after running copy
returned: success, src is a file
type: string
type: str
sample: 6e642bb8dd5c2e027bf21dd923337cbb4214f827
size:
description: size of the target, after execution
@@ -163,11 +163,11 @@ size:
operation:
description: whether a single file copy took place or a folder copy
returned: success
type: string
type: str
sample: file_copy
original_basename:
description: basename of the copied file
returned: changed, src is a file
type: string
type: str
sample: foo.txt
'''

8
lib/ansible/modules/windows/win_defrag.py
View File

@@ -68,7 +68,7 @@ RETURN = r'''
cmd:
description: The complete command line used by the module
returned: always
type: string
type: str
sample: defrag.exe /C /V
rc:
description: The return code for the command
@@ -78,17 +78,17 @@ rc:
stdout:
description: The standard output from the command
returned: always
type: string
type: str
sample: Success.
stderr:
description: The error output from the command
returned: always
type: string
type: str
sample:
msg:
description: Possible error message on failure
returned: failed
type: string
type: str
sample: Command 'defrag.exe' not found in $env:PATH.
changed:
description: Whether or not any changes were made.

100
lib/ansible/modules/windows/win_disk_facts.py
View File

@@ -77,17 +77,17 @@ ansible_facts:
bus_type:
description: Bus type of the particular disk.
returned: always
type: string
type: str
sample: "SCSI"
friendly_name:
description: Friendly name of the particular disk.
returned: always
type: string
type: str
sample: "Red Hat VirtIO SCSI Disk Device"
partition_style:
description: Partition style of the particular disk.
returned: always
type: string
type: str
sample: "MBR"
partition_count:
description: Number of partitions on the particular disk.
@@ -97,7 +97,7 @@ ansible_facts:
operational_status:
description: Operational status of the particular disk.
returned: always
type: string
type: str
sample: "Online"
sector_size:
description: Sector size in bytes of the particular disk.
@@ -127,42 +127,42 @@ ansible_facts:
manufacturer:
description: Manufacturer of the particular disk.
returned: always
type: string
type: str
sample: "Red Hat"
model:
description: Model specification of the particular disk.
returned: always
type: string
type: str
sample: "VirtIO"
firmware_version:
description: Firmware version of the particular disk.
returned: always
type: string
type: str
sample: "0001"
location:
description: Location of the particular disk on the target.
returned: always
type: string
type: str
sample: "PCIROOT(0)#PCI(0400)#SCSI(P00T00L00)"
serial_number:
description: Serial number of the particular disk on the target.
returned: always
type: string
type: str
sample: "b62beac80c3645e5877f"
unique_id:
description: Unique ID of the particular disk on the target.
returned: always
type: string
type: str
sample: "3141463431303031"
guid:
description: GUID of the particular disk on the target.
returned: if existent
type: string
type: str
sample: "{efa5f928-57b9-47fc-ae3e-902e85fbe77f}"
path:
description: Path of the particular disk on the target.
returned: always
type: string
type: str
sample: "\\\\?\\scsi#disk&ven_red_hat&prod_virtio#4&23208fd0&1&000000#{<id>}"
partitions:
description: Detailed information about one particular partition on the specified disk.
@@ -183,12 +183,12 @@ ansible_facts:
type:
description: Type of the particular partition.
returned: always
type: string
type: str
sample: "IFS"
gpt_type:
description: gpt type of the particular partition.
returned: if partition_style property of the particular disk has value "GPT"
type: string
type: str
sample: "{e3c9e316-0b5c-4db8-817d-f92df00215ae}"
no_default_driveletter:
description: Information whether the particular partition has a default drive letter or not.
@@ -208,7 +208,7 @@ ansible_facts:
drive_letter:
description: Drive letter of the particular partition.
returned: if existent
type: string
type: str
sample: "C"
transition_state:
description: Transition state of the particular partition.
@@ -233,12 +233,12 @@ ansible_facts:
guid:
description: GUID of the particular partition.
returned: if existent
type: string
type: str
sample: "{302e475c-6e64-4674-a8e2-2f1c7018bf97}"
access_paths:
description: Access paths of the particular partition.
returned: if existent
type: string
type: str
sample: "\\\\?\\Volume{85bdc4a8-f8eb-11e6-80fa-806e6f6e6963}\\"
volumes:
description: Detailed information about one particular volume on the specified partition.
@@ -260,22 +260,22 @@ ansible_facts:
type:
description: File system type of the particular volume.
returned: always
type: string
type: str
sample: "NTFS"
label:
description: File system label of the particular volume.
returned: always
type: string
type: str
sample: "System Reserved"
health_status:
description: Health status of the particular volume.
returned: always
type: string
type: str
sample: "Healthy"
drive_type:
description: Drive type of the particular volume.
returned: always
type: string
type: str
sample: "Fixed"
allocation_unit_size:
description: Allocation unit size in bytes of the particular volume.
@@ -285,12 +285,12 @@ ansible_facts:
object_id:
description: Object ID of the particular volume.
returned: always
type: string
type: str
sample: "\\\\?\\Volume{85bdc4a9-f8eb-11e6-80fa-806e6f6e6963}\\"
path:
description: Path of the particular volume.
returned: always
type: string
type: str
sample: "\\\\?\\Volume{85bdc4a9-f8eb-11e6-80fa-806e6f6e6963}\\"
physical_disk:
description: Detailed information about physical disk properties of the particular disk.
@@ -300,7 +300,7 @@ ansible_facts:
media_type:
description: Media type of the particular physical disk.
returned: always
type: string
type: str
sample: "UnSpecified"
size:
description:
@@ -317,32 +317,32 @@ ansible_facts:
device_id:
description: Device ID of the particular physical disk.
returned: always
type: string
type: str
sample: "0"
friendly_name:
description: Friendly name of the particular physical disk.
returned: always
type: string
type: str
sample: "PhysicalDisk0"
operational_status:
description: Operational status of the particular physical disk.
returned: always
type: string
type: str
sample: "OK"
health_status:
description: Health status of the particular physical disk.
returned: always
type: string
type: str
sample: "Healthy"
bus_type:
description: Bus type of the particular physical disk.
returned: always
type: string
type: str
sample: "SCSI"
usage_type:
description: Usage type of the particular physical disk.
returned: always
type: string
type: str
sample: "Auto-Select"
supported_usages:
description: Supported usage types of the particular physical disk.
@@ -357,7 +357,7 @@ ansible_facts:
value:
description: List of supported usage types.
returned: always
type: string
type: str
sample: "Auto-Select, Hot Spare"
spindle_speed:
description: Spindle speed in rpm of the particular physical disk.
@@ -367,17 +367,17 @@ ansible_facts:
physical_location:
description: Physical location of the particular physical disk.
returned: always
type: string
type: str
sample: "Integrated : Adapter 3 : Port 0 : Target 0 : LUN 0"
manufacturer:
description: Manufacturer of the particular physical disk.
returned: always
type: string
type: str
sample: "SUSE"
model:
description: Model of the particular physical disk.
returned: always
type: string
type: str
sample: "Xen Block"
can_pool:
description: Information whether the particular physical disk can be added to a storage pool.
@@ -387,7 +387,7 @@ ansible_facts:
cannot_pool_reason:
description: Information why the particular physical disk can not be added to a storage pool.
returned: if can_pool property has value false
type: string
type: str
sample: "Insufficient Capacity"
indication_enabled:
description: Information whether indication is enabled for the particular physical disk.
@@ -402,17 +402,17 @@ ansible_facts:
serial_number:
description: Serial number of the particular physical disk.
returned: always
type: string
type: str
sample: "b62beac80c3645e5877f"
object_id:
description: Object ID of the particular physical disk.
returned: always
type: string
type: str
sample: '{1}\\\\HOST\\root/Microsoft/Windows/Storage/Providers_v2\\SPACES_PhysicalDisk.ObjectId=\"{<object_id>}:PD:{<pd>}\"'
unique_id:
description: Unique ID of the particular physical disk.
returned: always
type: string
type: str
sample: "3141463431303031"
virtual_disk:
description: Detailed information about virtual disk properties of the particular disk.
@@ -440,27 +440,27 @@ ansible_facts:
name:
description: Name of the particular virtual disk.
returned: always
type: string
type: str
sample: "vDisk1"
friendly_name:
description: Friendly name of the particular virtual disk.
returned: always
type: string
type: str
sample: "Prod2 Virtual Disk"
operational_status:
description: Operational status of the particular virtual disk.
returned: always
type: string
type: str
sample: "OK"
health_status:
description: Health status of the particular virtual disk.
returned: always
type: string
type: str
sample: "Healthy"
provisioning_type:
description: Provisioning type of the particular virtual disk.
returned: always
type: string
type: str
sample: "Thin"
allocation_unit_size:
description: Allocation unit size in bytes of the particular virtual disk.
@@ -470,7 +470,7 @@ ansible_facts:
media_type:
description: Media type of the particular virtual disk.
returned: always
type: string
type: str
sample: "Unspecified"
parity_layout:
description: Parity layout of the particular virtual disk.
@@ -480,12 +480,12 @@ ansible_facts:
access:
description: Access of the particular virtual disk.
returned: always
type: string
type: str
sample: "Read/Write"
detached_reason:
description: Detached reason of the particular virtual disk.
returned: always
type: string
type: str
sample: "None"
write_cache_size:
description: Write cache size in byte of the particular virtual disk.
@@ -495,7 +495,7 @@ ansible_facts:
fault_domain_awareness:
description: Fault domain awareness of the particular virtual disk.
returned: always
type: string
type: str
sample: "PhysicalDisk"
inter_leave:
description:
@@ -576,16 +576,16 @@ ansible_facts:
object_id:
description: Object ID of the particular virtual disk.
returned: always
type: string
type: str
sample: '{1}\\\\HOST\\root/Microsoft/Windows/Storage/Providers_v2\\SPACES_VirtualDisk.ObjectId=\"{<object_id>}:VD:{<vd>}\"'
unique_id:
description: Unique ID of the particular virtual disk.
returned: always
type: string
type: str
sample: "260542E4C6B01D47A8FA7630FD90FFDE"
unique_id_format:
description: Unique ID format of the particular virtual disk.
returned: always
type: string
type: str
sample: "Vendor Specific"
'''

2
lib/ansible/modules/windows/win_disk_image.py
View File

@@ -34,7 +34,7 @@ RETURN = r'''
mount_path:
description: filesystem path where the target image is mounted, this has been deprecated in favour of C(mount_paths)
returned: when C(state) is C(present)
type: string
type: str
sample: F:\
mount_paths:
description: a list of filesystem paths mounted from the target image

2
lib/ansible/modules/windows/win_domain.py
View File

@@ -85,7 +85,7 @@ RETURN = r'''
reboot_required:
description: True if changes were made that require a reboot.
returned: always
type: boolean
type: bool
sample: true
'''

2
lib/ansible/modules/windows/win_domain_controller.py
View File

@@ -81,7 +81,7 @@ RETURN = '''
reboot_required:
description: True if changes were made that require a reboot.
returned: always
type: boolean
type: bool
sample: true
'''

20
lib/ansible/modules/windows/win_domain_group.py
View File

@@ -171,48 +171,48 @@ attributes:
canonical_name:
description: The canonical name of the group.
returned: group exists
type: string
type: str
sample: ansible.local/groups/Cow
category:
description: The Group type value of the group, i.e. Security or Distribution.
returned: group exists
type: string
type: str
sample: Security
description:
description: The Description of the group.
returned: group exists
type: string
type: str
sample: Group Description
display_name:
description: The Display name of the group.
returned: group exists
type: string
type: str
sample: Users who connect through RDP
distinguished_name:
description: The full Distinguished Name of the group.
returned: group exists
type: string
type: str
sample: CN=Cow,OU=groups,DC=ansible,DC=local
group_scope:
description: The Group scope value of the group.
returned: group exists
type: string
type: str
sample: Universal
guid:
description: The guid of the group.
returned: group exists
type: string
type: str
sample: 512a9adb-3fc0-4a26-9df0-e6ea1740cf45
managed_by:
description: The full Distinguished Name of the AD object that is set on the
managedBy attribute.
returned: group exists
type: string
type: str
sample: CN=Domain Admins,CN=Users,DC=ansible,DC=local
name:
description: The name of the group.
returned: group exists
type: string
type: str
sample: Cow
protected_from_accidental_deletion:
description: Whether the group is protected from accidental deletion.
@@ -222,6 +222,6 @@ protected_from_accidental_deletion:
sid:
description: The Security ID of the group.
returned: group exists
type: string
type: str
sample: S-1-5-21-2171456218-3732823212-122182344-1189
'''

2
lib/ansible/modules/windows/win_domain_membership.py
View File

@@ -58,7 +58,7 @@ RETURN = '''
reboot_required:
description: True if changes were made that require a reboot.
returned: always
type: boolean
type: bool
sample: true
'''

44
lib/ansible/modules/windows/win_domain_user.py
View File

@@ -229,52 +229,52 @@ RETURN = r'''
account_locked:
description: true if the account is locked
returned: always
type: boolean
type: bool
sample: false
changed:
description: true if the account changed during execution
returned: always
type: boolean
type: bool
sample: false
city:
description: The user city
returned: always
type: string
type: str
sample: Indianapolis
company:
description: The user company
returned: always
type: string
type: str
sample: RedHat
country:
description: The user country
returned: always
type: string
type: str
sample: US
description:
description: A description of the account
returned: always
type: string
type: str
sample: Server Administrator
distinguished_name:
description: DN of the user account
returned: always
type: string
type: str
sample: CN=nick,OU=test,DC=domain,DC=local
email:
description: The user email address
returned: always
type: string
type: str
sample: nick@domain.local
enabled:
description: true if the account is enabled and false if disabled
returned: always
type: string
type: str
sample: true
firstname:
description: The user first name
returned: always
type: string
type: str
sample: Nick
groups:
description: AD Groups to which the account belongs
@@ -284,61 +284,61 @@ groups:
msg:
description: Summary message of whether the user is present or absent
returned: always
type: string
type: str
sample: User nick is present
name:
description: The username on the account
returned: always
type: string
type: str
sample: nick
password_expired:
description: true if the account password has expired
returned: always
type: boolean
type: bool
sample: false
password_updated:
description: true if the password changed during this execution
returned: always
type: boolean
type: bool
sample: true
postal_code:
description: The user postal code
returned: always
type: string
type: str
sample: 46033
sid:
description: The SID of the account
returned: always
type: string
type: str
sample: S-1-5-21-2752426336-228313920-2202711348-1175
state:
description: The state of the user account
returned: always
type: string
type: str
sample: present
state_province:
description: The user state or province
returned: always
type: string
type: str
sample: IN
street:
description: The user street address
returned: always
type: string
type: str
sample: 123 4th St.
surname:
description: The user last name
returned: always
type: string
type: str
sample: Doe
upn:
description: The User Principal Name of the account
returned: always
type: string
type: str
sample: nick@domain.local
user_cannot_change_password:
description: true if the user is not allowed to change password
returned: always
type: string
type: str
sample: false
'''

6
lib/ansible/modules/windows/win_dsc.py
View File

@@ -135,17 +135,17 @@ RETURN = r'''
module_version:
description: The version of the dsc resource/module used.
returned: success
type: string
type: str
sample: "1.0.1"
reboot_required:
description: Flag returned from the DSC engine indicating whether or not
the machine requires a reboot for the invoked changes to take effect.
returned: always
type: boolean
type: bool
sample: True
message:
description: any error message from invoking the DSC resource
returned: error
type: string
type: str
sample: Multiple DSC modules found with resource name xyz
'''

4
lib/ansible/modules/windows/win_environment.py
View File

@@ -75,11 +75,11 @@ RETURN = r'''
before_value:
description: the value of the environment key before a change, this is null if it didn't exist
returned: always
type: string
type: str
sample: C:\Windows\System32
value:
description: the value the environment key has been set to, this is null if removed
returned: always
type: string
type: str
sample: C:\Program Files\jdk1.8
'''

6
lib/ansible/modules/windows/win_eventlog.py
View File

@@ -124,12 +124,12 @@ RETURN = r'''
name:
description: The name of the event log.
returned: always
type: string
type: str
sample: MyNewLog
exists:
description: Whether the event log exists or not.
returned: success
type: boolean
type: bool
sample: true
entries:
description: The count of entries present in the event log.
@@ -144,7 +144,7 @@ maximum_size_kb:
overflow_action:
description: The action the log takes once it reaches its maximum size.
returned: success
type: string
type: str
sample: OverwriteOlder
retention_days:
description: The minimum number of days entries are retained in the log.

14
lib/ansible/modules/windows/win_feature.py
View File

@@ -94,7 +94,7 @@ RETURN = r'''
exitcode:
description: The stringified exit code from the feature installation/removal command
returned: always
type: string
type: str
sample: Success
feature_result:
description: List of features that were installed or removed
@@ -105,7 +105,7 @@ feature_result:
display_name:
description: Feature display name
returned: always
type: string
type: str
sample: "Telnet Client"
id:
description: A list of KB article IDs that apply to the update
@@ -120,27 +120,27 @@ feature_result:
reboot_required:
description: True when the target server requires a reboot as a result of installing or removing this feature
returned: always
type: boolean
type: bool
sample: True
restart_needed:
description: DEPRECATED in Ansible 2.4 (refer to C(reboot_required) instead). True when the target server requires a reboot as a
result of installing or removing this feature
returned: always
type: boolean
type: bool
sample: True
skip_reason:
description: The reason a feature installation or removal was skipped
returned: always
type: string
type: str
sample: NotSkipped
success:
description: If the feature installation or removal was successful
returned: always
type: boolean
type: bool
sample: True
reboot_required:
description: True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot)
returned: success
type: boolean
type: bool
sample: True
'''

14
lib/ansible/modules/windows/win_file_version.py
View File

@@ -44,35 +44,35 @@ RETURN = r'''
win_file_version.path:
description: file path
returned: always
type: string
type: str
win_file_version.file_version:
description: file version number.
returned: no error
type: string
type: str
win_file_version.product_version:
description: the version of the product this file is distributed with.
returned: no error
type: string
type: str
win_file_version.file_major_part:
description: the major part of the version number.
returned: no error
type: string
type: str
win_file_version.file_minor_part:
description: the minor part of the version number of the file.
returned: no error
type: string
type: str
win_file_version.file_build_part:
description: build number of the file.
returned: no error
type: string
type: str
win_file_version.file_private_part:
description: file private part number.
returned: no error
type: string
type: str
'''

26
lib/ansible/modules/windows/win_find.py
View File

@@ -215,12 +215,12 @@ files:
attributes:
description: attributes of the file at path in raw form
returned: success, path exists
type: string
type: str
sample: "Archive, Hidden"
checksum:
description: The checksum of a file based on checksum_algorithm specified
returned: success, path exists, path is a file, get_checksum == True
type: string
type: str
sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98
creationtime:
description: the create time of the file represented in seconds since epoch
@@ -230,37 +230,37 @@ files:
extension:
description: the extension of the file at path
returned: success, path exists, path is a file
type: string
type: str
sample: ".ps1"
isarchive:
description: if the path is ready for archiving or not
returned: success, path exists
type: boolean
type: bool
sample: True
isdir:
description: if the path is a directory or not
returned: success, path exists
type: boolean
type: bool
sample: True
ishidden:
description: if the path is hidden or not
returned: success, path exists
type: boolean
type: bool
sample: True
islnk:
description: if the path is a symbolic link or junction or not
returned: success, path exists
type: boolean
type: bool
sample: True
isreadonly:
description: if the path is read only or not
returned: success, path exists
type: boolean
type: bool
sample: True
isshared:
description: if the path is shared or not
returned: success, path exists
type: boolean
type: bool
sample: True
lastaccesstime:
description: the last access time of the file represented in seconds since epoch
@@ -275,22 +275,22 @@ files:
lnk_source:
description: the target of the symbolic link, will return null if not a link or the link is broken
return: success, path exists, path is a symbolic link
type: string
type: str
sample: C:\temp
owner:
description: the owner of the file
returned: success, path exists
type: string
type: str
sample: BUILTIN\Administrators
path:
description: the full absolute path to the file
returned: success, path exists
type: string
type: str
sample: BUILTIN\Administrators
sharename:
description: the name of share if folder is shared
returned: success, path exists, path is a directory and isshared == True
type: string
type: str
sample: file-share
size:
description: the size in bytes of a file or folder

2
lib/ansible/modules/windows/win_firewall.py
View File

@@ -69,7 +69,7 @@ enabled:
profiles:
description: chosen profile
returned: always
type: string
type: str
sample: Domain
state:
description: desired state of the given firewall profile(s)

6
lib/ansible/modules/windows/win_get_url.py
View File

@@ -146,7 +146,7 @@ RETURN = r'''
dest:
description: destination file/path
returned: always
type: string
type: str
sample: C:\Users\RandomUser\earthrise.jpg
elapsed:
description: The elapsed seconds between the start of poll and the end of the module.
@@ -156,12 +156,12 @@ elapsed:
url:
description: requested url
returned: always
type: string
type: str
sample: http://www.example.com/earthrise.jpg
msg:
description: Error message, or HTTP status message from web-server
returned: always
type: string
type: str
sample: OK
status_code:
description: HTTP status code

2
lib/ansible/modules/windows/win_group_membership.py
View File

@@ -66,7 +66,7 @@ RETURN = r'''
name:
description: The name of the target local group.
returned: always
type: string
type: str
sample: Administrators
added:
description: A list of members added when C(state) is C(present); this is

4
lib/ansible/modules/windows/win_iis_webapplication.py
View File

@@ -58,11 +58,11 @@ RETURN = r'''
application_pool:
description: The used/implemented application_pool value
returned: success
type: string
type: str
sample: DefaultAppPool
physical_path:
description: The used/implemented physical_path value
returned: success
type: string
type: str
sample: C:\apps\acme\api
'''

16
lib/ansible/modules/windows/win_iis_webapppool.py
View File

@@ -127,7 +127,7 @@ attributes:
description: Application Pool attributes that were set and processed by this
module invocation.
returned: success
type: dictionary
type: dict
sample:
enable32BitAppOnWin64: "true"
managedRuntimeVersion: "v4.0"
@@ -143,7 +143,7 @@ info:
attributes:
description: Key value pairs showing the current Application Pool attributes.
returned: success
type: dictionary
type: dict
sample:
autoStart: true
managedRuntimeLoader: "webengine4.dll"
@@ -161,7 +161,7 @@ info:
cpu:
description: Key value pairs showing the current Application Pool cpu attributes.
returned: success
type: dictionary
type: dict
sample:
action: "NoAction"
limit: 0
@@ -171,7 +171,7 @@ info:
failure:
description: Key value pairs showing the current Application Pool failure attributes.
returned: success
type: dictionary
type: dict
sample:
autoShutdownExe: ""
orphanActionExe: ""
@@ -181,12 +181,12 @@ info:
name:
description: Name of Application Pool that was processed by this module invocation.
returned: success
type: string
type: str
sample: "DefaultAppPool"
processModel:
description: Key value pairs showing the current Application Pool processModel attributes.
returned: success
type: dictionary
type: dict
sample:
identityType: "ApplicationPoolIdentity"
logonType: "LogonBatch"
@@ -196,7 +196,7 @@ info:
recycling:
description: Key value pairs showing the current Application Pool recycling attributes.
returned: success
type: dictionary
type: dict
sample:
disallowOverlappingRotation: false
disallowRotationOnConfigChange: false
@@ -204,6 +204,6 @@ info:
state:
description: Current runtime state of the pool as the module completed.
returned: success
type: string
type: str
sample: "Started"
'''

6
lib/ansible/modules/windows/win_iis_webbinding.py
View File

@@ -114,7 +114,7 @@ website_state:
- Can be helpful in case you accidentally cause a binding collision
which can result in the targetted site being stopped
returned: always
type: string
type: str
sample: "Started"
version_added: "2.5"
operation_type:
@@ -122,14 +122,14 @@ operation_type:
- The type of operation performed
- Can be removed, updated, matched, or added
returned: on success
type: string
type: str
sample: "removed"
version_added: "2.5"
binding_info:
description:
- Information on the binding being manipulated
returned: on success
type: dictionary
type: dict
sample: |-
"binding_info": {
"bindingInformation": "127.0.0.1:443:",

10
lib/ansible/modules/windows/win_msg.py
View File

@@ -64,12 +64,12 @@ RETURN = r'''
msg:
description: Test of the message that was sent.
returned: changed
type: string
type: str
sample: Automated upgrade about to start. Please save your work and log off before 22 July 2016 18:00:00
display_seconds:
description: Value of display_seconds module parameter.
returned: success
type: string
type: str
sample: 10
rc:
description: The return code of the API call
@@ -79,16 +79,16 @@ rc:
runtime_seconds:
description: How long the module took to run on the remote windows host.
returned: success
type: string
type: str
sample: 22 July 2016 17:45:51
sent_localtime:
description: local time from windows host when the message was sent.
returned: success
type: string
type: str
sample: 22 July 2016 17:45:51
wait:
description: Value of wait module parameter.
returned: success
type: boolean
type: bool
sample: false
'''

2
lib/ansible/modules/windows/win_pagefile.py
View File

@@ -124,7 +124,7 @@ RETURN = r'''
automatic_managed_pagefiles:
description: Whether the pagefiles is automatically managed.
returned: When state is query.
type: boolean
type: bool
sample: true
pagefiles:
description: Contains caption, description, initial_size, maximum_size and name for each pagefile in the system.

2
lib/ansible/modules/windows/win_pester.py
View File

@@ -36,7 +36,7 @@ RETURN = r'''
pester_version:
description: Version of the pester module found on the remote host.
returned: always
type: string
type: str
sample: 4.3.1
output:
description: Results of the Pester tests.

2
lib/ansible/modules/windows/win_ping.py
View File

@@ -52,6 +52,6 @@ RETURN = '''
ping:
description: value provided with the data parameter
returned: success
type: string
type: str
sample: pong
'''

6
lib/ansible/modules/windows/win_power_plan.py
View File

@@ -39,17 +39,17 @@ RETURN = r'''
power_plan_name:
description: Value of the intended power plan
returned: always
type: string
type: str
sample: balanced
power_plan_enabled:
description: State of the intended power plan
returned: success
type: boolean
type: bool
sample: True
all_available_plans:
description: The name and enabled state of all power plans
returned: always
type: dictionary
type: dict
sample: |
{
"High performance": false,

2
lib/ansible/modules/windows/win_product_facts.py
View File

@@ -29,7 +29,7 @@ RETURN = '''
ansible_facts:
description: returned facts by this module
returned: always
type: dictionary
type: dict
sample:
ansible_os_product_id: 00326-10000-00000-AA698
ansible_os_product_key: T49TD-6VFBW-VV7HY-B2PXY-MY47H

6
lib/ansible/modules/windows/win_psexec.py
View File

@@ -150,7 +150,7 @@ RETURN = r'''
cmd:
description: The complete command line used by the module, including PsExec call and additional options.
returned: always
type: string
type: str
sample: psexec.exe -nobanner \\remote_server -u "DOMAIN\Administrator" -p "some_password" -accepteula E:\setup.exe
rc:
description: The return code for the command
@@ -160,11 +160,11 @@ rc:
stdout:
description: The standard output from the command
returned: always
type: string
type: str
sample: Success.
stderr:
description: The error output from the command
returned: always
type: string
type: str
sample: Error 15 running E:\setup.exe
'''

6
lib/ansible/modules/windows/win_psmodule.py
View File

@@ -86,15 +86,15 @@ output:
description: a message describing the task result.
returned: always
sample: "Module PowerShellCookbook installed"
type: string
type: str
nuget_changed:
description: true when Nuget package provider is installed
returned: always
type: boolean
type: bool
sample: True
repository_changed:
description: true when a custom repository is installed or removed
returned: always
type: boolean
type: bool
sample: True
'''

2
lib/ansible/modules/windows/win_reboot.py
View File

@@ -111,7 +111,7 @@ RETURN = r'''
rebooted:
description: true if the machine was rebooted
returned: always
type: boolean
type: bool
sample: true
elapsed:
description: The number of seconds that elapsed waiting for the system to be rebooted.

10
lib/ansible/modules/windows/win_reg_stat.py
View File

@@ -53,12 +53,12 @@ RETURN = r'''
changed:
description: Whether anything was changed.
returned: always
type: boolean
type: bool
sample: True
exists:
description: States whether the registry key/property exists.
returned: success and path/property exists
type: boolean
type: bool
sample: True
properties:
description: A dictionary containing all the properties and their values in the registry key.
@@ -89,16 +89,16 @@ raw_value:
description: Returns the raw value of the registry property, REG_EXPAND_SZ has no string expansion, REG_BINARY or REG_NONE is in hex 0x format.
REG_NONE, this value is a hex string in the 0x format.
returned: success, path/property exists and property specified
type: string
type: str
sample: '%ProgramDir%\\Common Files'
type:
description: The property type.
returned: success, path/property exists and property specified
type: string
type: str
sample: "REG_EXPAND_SZ"
value:
description: The value of the property.
returned: success, path/property exists and property specified
type: string
type: str
sample: 'C:\\Program Files\\Common Files'
'''

6
lib/ansible/modules/windows/win_regedit.py
View File

@@ -186,7 +186,7 @@ EXAMPLES = r'''
path: HKLM:\ANSIBLE\Control Panel\Mouse
name: MouseTrails
data: 10
type: string
type: str
state: present
hive: C:\Users\Default\NTUSER.dat
'''
@@ -195,11 +195,11 @@ RETURN = r'''
data_changed:
description: whether this invocation changed the data in the registry value
returned: success
type: boolean
type: bool
sample: False
data_type_changed:
description: whether this invocation changed the datatype of the registry value
returned: success
type: boolean
type: bool
sample: True
'''

2
lib/ansible/modules/windows/win_region.py
View File

@@ -90,6 +90,6 @@ RETURN = r'''
restart_required:
description: Whether a reboot is required for the change to take effect
returned: success
type: boolean
type: bool
sample: True
'''

4
lib/ansible/modules/windows/win_regmerge.py
View File

@@ -66,7 +66,7 @@ RETURN = r'''
compare_to_key_found:
description: whether the parent registry key has been found for comparison
returned: when comparison key not found in registry
type: boolean
type: bool
sample: false
difference_count:
description: number of differences between the registry and the file
@@ -76,6 +76,6 @@ difference_count:
compared:
description: whether a comparison has taken place between the registry and the file
returned: when a comparison key has been supplied and comparison has been attempted
type: boolean
type: bool
sample: true
'''

12
lib/ansible/modules/windows/win_robocopy.py
View File

@@ -99,17 +99,17 @@ RETURN = r'''
cmd:
description: The used command line
returned: always
type: string
type: str
sample: robocopy C:\DirectoryOne C:\DirectoryTwo /e /purge
src:
description: The Source file/directory of the sync.
returned: always
type: string
type: str
sample: C:\Some\Path
dest:
description: The Destination file/directory of the sync.
returned: always
type: string
type: str
sample: C:\Some\Path
recurse:
description: Whether or not the recurse flag was toggled.
@@ -124,7 +124,7 @@ purge:
flags:
description: Any flags passed in by the user.
returned: always
type: string
type: str
sample: /e /purge
rc:
description: The return code returned by robocopy.
@@ -134,11 +134,11 @@ rc:
output:
description: The output of running the robocopy command.
returned: success
type: string
type: str
sample: "------------------------------------\\n ROBOCOPY :: Robust File Copy for Windows \\n------------------------------------\\n "
msg:
description: Output intrepreted into a concise message.
returned: always
type: string
type: str
sample: No files copied!
'''

2
lib/ansible/modules/windows/win_route.py
View File

@@ -62,6 +62,6 @@ RETURN = r'''
output:
description: A message describing the task result.
returned: always
type: string
type: str
sample: "Route added"
'''

6
lib/ansible/modules/windows/win_say.py
View File

@@ -100,16 +100,16 @@ RETURN = r'''
message_text:
description: the text that the module attempted to speak
returned: success
type: string
type: str
sample: "Warning, deployment commencing in 5 minutes."
voice:
description: the voice used to speak the text.
returned: success
type: string
type: str
sample: Microsoft Hazel Desktop
voice_info:
description: the voice used to speak the text.
returned: when requested voice could not be loaded
type: string
type: str
sample: Could not load voice TestVoice, using system default voice
'''

8
lib/ansible/modules/windows/win_scheduled_task_stat.py
View File

@@ -69,7 +69,7 @@ actions:
folder_exists:
description: Whether the folder set at path exists.
returned: always
type: boolean
type: bool
sample: True
folder_task_count:
description: The number of tasks that exist in the folder.
@@ -219,7 +219,7 @@ settings:
idle_settings:
description: The idle settings of the task.
returned: ''
type: dictionary
type: dict
sample: {
"idle_duration": "PT10M",
"restart_on_idle": false,
@@ -240,7 +240,7 @@ settings:
network_settings:
description: The network settings of the task.
returned: ''
type: dictionary
type: dict
sample: {
"id": null,
"name": null
@@ -335,7 +335,7 @@ state:
task_exists:
description: Whether the task at the folder exists.
returned: name is specified
type: boolean
type: bool
sample: True
triggers:
description: A list of triggers.

12
lib/ansible/modules/windows/win_security_policy.py
View File

@@ -91,33 +91,33 @@ stdout:
description: The output of the STDOUT buffer after a failure when running
SecEdit.exe.
returned: failure with secedit calls
type: string
type: str
sample: check log for error details
stderr:
description: The output of the STDERR buffer after a failure when running
SecEdit.exe.
returned: failure with secedit calls
type: string
type: str
sample: failed to import security policy
import_log:
description: The log of the SecEdit.exe /configure job that configured the
local policies. This is used for debugging purposes on failures.
returned: secedit.exe /import run and change occurred
type: string
type: str
sample: Completed 6 percent (0/15) \tProcess Privilege Rights area.
key:
description: The key in the section passed to the module to modify.
returned: success
type: string
type: str
sample: NewGuestName
section:
description: The section passed to the module to modify.
returned: success
type: string
type: str
sample: System Access
value:
description: The value passed to the module to modify to.
returned: success
type: string
type: str
sample: Guest Account
'''

18
lib/ansible/modules/windows/win_service.py
View File

@@ -232,32 +232,32 @@ RETURN = r'''
exists:
description: Whether the service exists or not.
returned: success
type: boolean
type: bool
sample: true
name:
description: The service name or id of the service.
returned: success and service exists
type: string
type: str
sample: CoreMessagingRegistrar
display_name:
description: The display name of the installed service.
returned: success and service exists
type: string
type: str
sample: CoreMessaging
state:
description: The current running status of the service.
returned: success and service exists
type: string
type: str
sample: stopped
start_mode:
description: The startup type of the service.
returned: success and service exists
type: string
type: str
sample: manual
path:
description: The path to the service executable.
returned: success and service exists
type: string
type: str
sample: C:\Windows\system32\svchost.exe -k LocalServiceNoNetwork
can_pause_and_continue:
description: Whether the service can be paused and unpaused.
@@ -267,17 +267,17 @@ can_pause_and_continue:
description:
description: The description of the service.
returned: success and service exists
type: string
type: str
sample: Manages communication between system components.
username:
description: The username that runs the service.
returned: success and service exists
type: string
type: str
sample: LocalSystem
desktop_interact:
description: Whether the current user is allowed to interact with the desktop.
returned: success and service exists
type: boolean
type: bool
sample: False
dependencies:
description: A list of services that is depended by this service.

14
lib/ansible/modules/windows/win_shell.py
View File

@@ -105,37 +105,37 @@ RETURN = r'''
msg:
description: changed
returned: always
type: boolean
type: bool
sample: True
start:
description: The command execution start time
returned: always
type: string
type: str
sample: '2016-02-25 09:18:26.429568'
end:
description: The command execution end time
returned: always
type: string
type: str
sample: '2016-02-25 09:18:26.755339'
delta:
description: The command execution delta time
returned: always
type: string
type: str
sample: '0:00:00.325771'
stdout:
description: The command standard output
returned: always
type: string
type: str
sample: 'Clustering node rabbit@slave1 with rabbit@master ...'
stderr:
description: The command standard error
returned: always
type: string
type: str
sample: 'ls: cannot access foo: No such file or directory'
cmd:
description: The command executed by the task
returned: always
type: string
type: str
sample: 'rabbitmqctl join_cluster rabbit@master'
rc:
description: The command return code (0 means success)

40
lib/ansible/modules/windows/win_stat.py
View File

@@ -105,7 +105,7 @@ RETURN = r'''
changed:
description: Whether anything was changed
returned: always
type: boolean
type: bool
sample: True
stat:
description: dictionary containing all the stat data
@@ -115,13 +115,13 @@ stat:
attributes:
description: Attributes of the file at path in raw form
returned: success, path exists
type: string
type: str
sample: "Archive, Hidden"
checksum:
description: The checksum of a file based on checksum_algorithm specified
returned: success, path exist, path is a file, get_checksum == True
checksum_algorithm specified is supported
type: string
type: str
sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98
creationtime:
description: The create time of the file represented in seconds since epoch
@@ -131,17 +131,17 @@ stat:
exists:
description: If the path exists or not
returned: success
type: boolean
type: bool
sample: True
extension:
description: The extension of the file at path
returned: success, path exists, path is a file
type: string
type: str
sample: ".ps1"
filename:
description: The name of the file (without path)
returned: success, path exists, path is a file
type: string
type: str
sammple: foo.ini
hlnk_targets:
description: List of other files pointing to the same file (hard links), excludes the current file
@@ -153,42 +153,42 @@ stat:
isarchive:
description: If the path is ready for archiving or not
returned: success, path exists
type: boolean
type: bool
sample: True
isdir:
description: If the path is a directory or not
returned: success, path exists
type: boolean
type: bool
sample: True
ishidden:
description: If the path is hidden or not
returned: success, path exists
type: boolean
type: bool
sample: True
isjunction:
description: If the path is a junction point or not
returned: success, path exists
type: boolean
type: bool
sample: True
islnk:
description: If the path is a symbolic link or not
returned: success, path exists
type: boolean
type: bool
sample: True
isreadonly:
description: If the path is read only or not
returned: success, path exists
type: boolean
type: bool
sample: True
isreg:
description: If the path is a regular file
returned: success, path exists
type: boolean
type: bool
sample: True
isshared:
description: If the path is shared or not
returned: success, path exists
type: boolean
type: bool
sample: True
lastaccesstime:
description: The last access time of the file represented in seconds since epoch
@@ -203,17 +203,17 @@ stat:
lnk_source:
description: Target of the symlink normalized for the remote filesystem
returned: success, path exists and the path is a symbolic link or junction point
type: string
type: str
sample: C:\temp\link
lnk_target:
description: Target of the symlink. Note that relative paths remain relative
returned: success, path exists and the path is a symbolic link or junction point
type: string
type: str
sample: ..\link
md5:
description: The MD5 checksum of a file (Between Ansible 1.9 and 2.2 this was returned as a SHA1 hash), will be removed in 2.9
returned: success, path exist, path is a file, get_md5 == True
type: string
type: str
sample: 09cb79e8fc7453c84a07f644e441fd81623b7f98
nlink:
description: Number of links to the file (hard links)
@@ -223,17 +223,17 @@ stat:
owner:
description: The owner of the file
returned: success, path exists
type: string
type: str
sample: BUILTIN\Administrators
path:
description: The full absolute path to the file
returned: success, path exists, file exists
type: string
type: str
sample: C:\foo.ini
sharename:
description: The name of share if folder is shared
returned: success, path exists, file is a directory and isshared == True
type: string
type: str
sample: file-share
size:
description: The size in bytes of a file or folder

2
lib/ansible/modules/windows/win_tempfile.py
View File

@@ -60,6 +60,6 @@ RETURN = r'''
path:
description: Path to created file or directory
returned: success
type: string
type: str
sample: C:\Users\Administrator\AppData\Local\Temp\ansible.bMlvdk
'''

4
lib/ansible/modules/windows/win_timezone.py
View File

@@ -52,11 +52,11 @@ RETURN = r'''
previous_timezone:
description: The previous timezone if it was changed, otherwise the existing timezone
returned: success
type: string
type: str
sample: Central Standard Time
timezone:
description: The current timezone (possibly changed)
returned: success
type: string
type: str
sample: Central Standard Time
'''

8
lib/ansible/modules/windows/win_toast.py
View File

@@ -73,17 +73,17 @@ RETURN = r'''
expire_at_utc:
description: Calculated utc date time when the notification expires.
returned: allways
type: string
type: str
sample: 07 July 2017 04:50:54
no_toast_sent_reason:
description: Text containing the reason why a notification was not sent.
returned: when no logged in users are detected
type: string
type: str
sample: No logged in users to notify
sent_localtime:
description: local date time when the notification was sent.
returned: allways
type: string
type: str
sample: 07 July 2017 05:45:54
time_taken:
description: How long the module took to run on the remote windows host in seconds.
@@ -93,6 +93,6 @@ time_taken:
toast_sent:
description: Whether the module was able to send a toast notification or not.
returned: allways
type: boolean
type: bool
sample: false
'''

6
lib/ansible/modules/windows/win_unzip.py
View File

@@ -99,16 +99,16 @@ RETURN = r'''
dest:
description: The provided destination path
returned: always
type: string
type: str
sample: C:\ExtractedLogs\application-error-logs
removed:
description: Whether the module did remove any files during task run
returned: always
type: boolean
type: bool
sample: True
src:
description: The provided source path
returned: always
type: string
type: str
sample: C:\Logs\application-error-logs.gz
'''

12
lib/ansible/modules/windows/win_updates.py
View File

@@ -174,7 +174,7 @@ RETURN = r'''
reboot_required:
description: True when the target server requires a reboot to complete updates (no further updates can be installed until after a reboot)
returned: success
type: boolean
type: bool
sample: True
updates:
@@ -186,7 +186,7 @@ updates:
title:
description: Display name
returned: always
type: string
type: str
sample: "Security Update for Windows Server 2012 R2 (KB3004365)"
kb:
description: A list of KB article IDs that apply to the update
@@ -196,12 +196,12 @@ updates:
id:
description: Internal Windows Update GUID
returned: always
type: string (guid)
type: str (guid)
sample: "fb95c1c8-de23-4089-ae29-fd3351d55421"
installed:
description: Was the update successfully installed
returned: always
type: boolean
type: bool
sample: True
categories:
description: A list of category strings for this update
@@ -211,7 +211,7 @@ updates:
failure_hresult_code:
description: The HRESULT code from a failed update
returned: on install failure
type: boolean
type: bool
sample: 2147942402
filtered_updates:
@@ -225,7 +225,7 @@ filtered_updates:
filtered_reason:
description: The reason why this update was filtered
returned: always
type: string
type: str
sample: 'skip_hidden'
found_update_count:

6
lib/ansible/modules/windows/win_uri.py
View File

@@ -185,7 +185,7 @@ elapsed:
url:
description: The Target URL
returned: always
type: string
type: str
sample: https://www.ansible.com
status_code:
description: The HTTP Status Code of the response.
@@ -195,12 +195,12 @@ status_code:
status_description:
description: A summary of the status.
returned: success
type: string
type: str
sample: OK
content:
description: The raw content of the HTTP response.
returned: success and return_content is True
type: string
type: str
sample: '{"foo": "bar"}'
content_length:
description: The byte size of the response.

4
lib/ansible/modules/windows/win_xml.py
View File

@@ -75,7 +75,7 @@ RETURN = r'''
msg:
description: what was done
returned: always
type: string
type: str
sample: "xml added"
err:
description: xml comparison exceptions
@@ -85,6 +85,6 @@ err:
backup:
description: name of the backup file, if created
returned: changed
type: string
type: str
sample: C:\config.xml.19700101-000000
'''