starred/ansible
1
0
Fork 0
mirror of https://github.com/ansible/ansible.git synced 2026-08-03 08:03:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

[stable-2.16] uri: update docs for follow_redirects (#83177)

Browse Source 
* [stable-2.16] uri: update docs for follow_redirects

* Updated the docs for the parameter follow_redirects

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit fcc6d0bd0c)

* CI fixes

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

---------

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde
2024-05-09 09:36:16 -07:00
committed by GitHub
parent 3761e11a5c
commit b92e2eb20b
3 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changelogs/fragments/uri_follow_redirect_bool.yml
+3
View File
@@ -0,0 +1,3 @@
---
bugfixes:
- uri - update the documentation for follow_redirects.
lib/ansible/modules/uri.py
+8 -7
View File
@@ -108,14 +108,15 @@ options:
default: no
follow_redirects:
description:
- Whether or not the URI module should follow redirects. V(all) will follow all redirects.
V(safe) will follow only "safe" redirects, where "safe" means that the client is only
doing a GET or HEAD on the URI to which it is being redirected. V(none) will not follow
any redirects. Note that V(true) and V(false) choices are accepted for backwards compatibility,
where V(true) is the equivalent of V(all) and V(false) is the equivalent of V(safe). V(true) and V(false)
are deprecated and will be removed in some future version of Ansible.
- Whether or not the URI module should follow redirects.
- V(all) Will follow all redirects.
- V(none) Will not follow any redirects.
- V(safe) Only redirects doing GET or HEAD requests will be followed.
- V(urllib2) Defer to urllib2 behavior (As of writing this follows HTTP redirects).
- V('no') (DEPRECATED, will be removed in the future version) alias of V(none).
- V('yes') (DEPRECATED, will be removed in the future version) alias of V(all).
choices: ['all', 'none', 'safe', 'urllib2', 'yes', 'no']
type: str
choices: ['all', 'no', 'none', 'safe', 'urllib2', 'yes']
default: safe
creates:
description:
lib/ansible/plugins/lookup/url.py
+9 -1
View File
@@ -88,7 +88,14 @@ options:
- section: url_lookup
key: force_basic_auth
follow_redirects:
description: String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information
description:
- String of urllib2, all/yes, safe, none to determine how redirects are followed, see RedirectHandlerFactory for more information.
- V(all) Will follow all redirects.
- V(none) Will not follow any redirects.
- V(safe) Only redirects doing GET or HEAD requests will be followed.
- V(urllib2) Defer to urllib2 behavior (As of writing this follows HTTP redirects).
- V('no') (DEPRECATED, will be removed in the future version) alias of V(none).
- V('yes') (DEPRECATED, will be removed in the future version) alias of V(all).
type: string
version_added: "2.10"
default: 'urllib2'
@@ -99,6 +106,7 @@ options:
ini:
- section: url_lookup
key: follow_redirects
choices: ['all', 'none', 'safe', 'urllib2', 'yes', 'no']
use_gssapi:
description:
- Use GSSAPI handler of requests