@ -25,26 +25,32 @@ options:
follow :
description :
- Whether to follow symlinks .
choices : [ ' no ' , ' yes ' ]
type : bool
default : ' no '
get_md5 :
description :
- Whether to return the md5 sum of the file .
- Will return None if not a regular file or if we ' re
unable to use md5 ( Common for FIPS - 140 compliant systems ) .
choices : [ ' no ' , ' yes ' ]
default : ' yes '
- The default of this option changed from C ( yes ) to C ( no ) in Ansible 2.5
and will be removed altogether in Ansible 2.9 .
- Use C ( get_checksum = true ) with C ( checksum_algorithm = md5 ) to return an
md5 hash under the C ( checksum ) return value .
type : bool
default : ' no '
get_checksum :
description :
- Whether to return a checksum of the file ( default sha1 ) .
choices : [ ' no ' , ' yes ' ]
type : bool
default : ' yes '
version_added : " 1.8 "
checksum_algorithm :
description :
- Algorithm to determine checksum of file . Will throw an error if the
host is unable to use specified algorithm .
choices : [ sha1 , sha224 , sha256 , sha384 , sha512 ]
- The remote host has to support the hashing method specified , C ( md5 )
can be unavailable if the host is FIPS - 140 compliant .
choices : [ md5 , sha1 , sha224 , sha256 , sha384 , sha512 ]
default : sha1
aliases : [ checksum , checksum_algo ]
version_added : " 2.0 "
@ -54,14 +60,14 @@ options:
the ' file ' utility found on most Linux / Unix systems .
- This will add both ` mime_type ` and ' charset ' fields to the return , if possible .
- In 2.3 this option changed from ' mime ' to ' get_mime ' and the default changed to ' Yes ' .
choices : [ ' no ' , ' yes ' ]
type : bool
default : ' yes '
version_added : " 2.1 "
aliases : [ mime , mime_type , mime - type ]
get_attributes :
description :
- Get file attributes using lsattr tool if present .
choices : [ ' no ' , ' yes ' ]
type : bool
default : ' yes '
version_added : " 2.3 "
aliases : [ attr , attributes ]
@ -294,7 +300,8 @@ stat:
sample : . . / foobar / 21102015 - 1445431274 - 908472971
version_added : 2.4
md5 :
description : md5 hash of the path
description : md5 hash of the path , this will be removed in Ansible 2.9 in
favour of the checksum return value
returned : success , path exists and user can read stats and path
supports hashing and md5 is supported
type : string
@ -433,12 +440,12 @@ def main():
argument_spec = dict (
path = dict ( required = True , type = ' path ' ) ,
follow = dict ( type = ' bool ' , default = ' no ' ) ,
get_md5 = dict ( type = ' bool ' , default = ' yes ' ),
get_md5 = dict ( type = ' bool ' ,
get_checksum = dict ( type = ' bool ' , default = ' yes ' ) ,
get_mime = dict ( type = ' bool ' , default = ' yes ' , aliases = [ ' mime ' , ' mime_type ' , ' mime-type ' ] ) ,
get_attributes = dict ( type = ' bool ' , default = ' yes ' , aliases = [ ' attr ' , ' attributes ' ] ) ,
checksum_algorithm = dict ( type = ' str ' , default = ' sha1 ' ,
choices = [ ' ' , ' sha224 ' , ' sha256 ' , ' sha384 ' , ' sha512 ' ] ,
choices = [ ' md5' , ' sha1' , ' sha224 ' , ' sha256 ' , ' sha384 ' , ' sha512 ' ] ,
aliases = [ ' checksum ' , ' checksum_algo ' ] ) ,
) ,
supports_check_mode = True ,
@ -450,6 +457,14 @@ def main():
get_mime = module . params . get ( ' get_mime ' )
get_attr = module . params . get ( ' get_attributes ' )
get_md5 = module . params . get ( ' get_md5 ' )
# get_md5 will be an undocumented option in 2.9 to be removed at a later
# date if possible (3.0+)
if get_md5 :
module . deprecate ( " get_md5 has been deprecated along with the md5 return value, use "
" get_checksum=True and checksum_algorithm=md5 instead " , 2.9 )
else :
get_md5 = False
get_checksum = module . params . get ( ' get_checksum ' )
checksum_algorithm = module . params . get ( ' checksum_algorithm ' )
Jordan Borean
8 years ago
committed by