Un-migrate url_windows doc fragment (#68602)
* Un-migrate url_windows doc fragment * Removed from routing file
This commit is contained in:
parent
f5178f9705
commit
e785bdaa5b
4 changed files with 153 additions and 4 deletions
6
.github/BOTMETA.yml
vendored
6
.github/BOTMETA.yml
vendored
|
@ -4008,6 +4008,10 @@ files:
|
||||||
migrated_to: f5networks.f5_modules
|
migrated_to: f5networks.f5_modules
|
||||||
$plugins/doc_fragments/tower.py:
|
$plugins/doc_fragments/tower.py:
|
||||||
migrated_to: awx.awx
|
migrated_to: awx.awx
|
||||||
|
$plugins/doc_fragments/url_windows.py:
|
||||||
|
labels: windows
|
||||||
|
maintainers: $team_windows_core
|
||||||
|
support: core
|
||||||
$plugins/filter/:
|
$plugins/filter/:
|
||||||
support: community
|
support: community
|
||||||
$plugins/filter/__init__.py:
|
$plugins/filter/__init__.py:
|
||||||
|
@ -19612,8 +19616,6 @@ files:
|
||||||
migrated_to: ansible.windows
|
migrated_to: ansible.windows
|
||||||
lib/ansible/plugins/action/win_updates.py:
|
lib/ansible/plugins/action/win_updates.py:
|
||||||
migrated_to: ansible.windows
|
migrated_to: ansible.windows
|
||||||
lib/ansible/plugins/doc_fragments/url_windows.py:
|
|
||||||
migrated_to: ansible.windows
|
|
||||||
test/integration/targets/win_setup/aliases:
|
test/integration/targets/win_setup/aliases:
|
||||||
migrated_to: ansible.windows
|
migrated_to: ansible.windows
|
||||||
test/integration/targets/win_setup/tasks/main.yml:
|
test/integration/targets/win_setup/tasks/main.yml:
|
||||||
|
|
|
@ -8433,8 +8433,6 @@ plugin_routing:
|
||||||
redirect: ansible.netcommon.netconf
|
redirect: ansible.netcommon.netconf
|
||||||
network_agnostic:
|
network_agnostic:
|
||||||
redirect: ansible.netcommon.network_agnostic
|
redirect: ansible.netcommon.network_agnostic
|
||||||
url_windows:
|
|
||||||
redirect: ansible.windows.url_windows
|
|
||||||
fortios:
|
fortios:
|
||||||
redirect: fortinet.fortios.fortios
|
redirect: fortinet.fortios.fortios
|
||||||
netapp:
|
netapp:
|
||||||
|
|
|
@ -518,6 +518,7 @@ Function Merge-WebRequestSpec {
|
||||||
$ModuleSpec
|
$ModuleSpec
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# See lib/ansible/plugins/doc_fragments/url_windows.py
|
||||||
$ansible_web_request_options = @{
|
$ansible_web_request_options = @{
|
||||||
method = @{ type="str" }
|
method = @{ type="str" }
|
||||||
follow_redirects = @{ type="str"; choices=@("all","none","safe"); default="safe" }
|
follow_redirects = @{ type="str"; choices=@("all","none","safe"); default="safe" }
|
||||||
|
|
148
lib/ansible/plugins/doc_fragments/url_windows.py
Normal file
148
lib/ansible/plugins/doc_fragments/url_windows.py
Normal file
|
@ -0,0 +1,148 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# Copyright (c) 2019 Ansible Project
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
class ModuleDocFragment:
|
||||||
|
|
||||||
|
# Common options for Ansible.ModuleUtils.WebRequest
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
options:
|
||||||
|
method:
|
||||||
|
description:
|
||||||
|
- The HTTP Method of the request.
|
||||||
|
type: str
|
||||||
|
follow_redirects:
|
||||||
|
description:
|
||||||
|
- Whether or the module should follow redirects.
|
||||||
|
- C(all) will follow all redirect.
|
||||||
|
- C(none) will not follow any redirect.
|
||||||
|
- C(safe) will follow only "safe" redirects, where "safe" means that the
|
||||||
|
client is only doing a C(GET) or C(HEAD) on the URI to which it is being
|
||||||
|
redirected.
|
||||||
|
choices:
|
||||||
|
- all
|
||||||
|
- none
|
||||||
|
- safe
|
||||||
|
default: safe
|
||||||
|
type: str
|
||||||
|
headers:
|
||||||
|
description:
|
||||||
|
- Extra headers to set on the request.
|
||||||
|
- This should be a dictionary where the key is the header name and the
|
||||||
|
value is the value for that header.
|
||||||
|
type: dict
|
||||||
|
http_agent:
|
||||||
|
description:
|
||||||
|
- Header to identify as, generally appears in web server logs.
|
||||||
|
- This is set to the C(User-Agent) header on a HTTP request.
|
||||||
|
default: ansible-httpget
|
||||||
|
type: str
|
||||||
|
maximum_redirection:
|
||||||
|
description:
|
||||||
|
- Specify how many times the module will redirect a connection to an
|
||||||
|
alternative URI before the connection fails.
|
||||||
|
- If set to C(0) or I(follow_redirects) is set to C(none), or C(safe) when
|
||||||
|
not doing a C(GET) or C(HEAD) it prevents all redirection.
|
||||||
|
default: 50
|
||||||
|
type: int
|
||||||
|
timeout:
|
||||||
|
description:
|
||||||
|
- Specifies how long the request can be pending before it times out (in
|
||||||
|
seconds).
|
||||||
|
- Set to C(0) to specify an infinite timeout.
|
||||||
|
default: 30
|
||||||
|
type: int
|
||||||
|
validate_certs:
|
||||||
|
description:
|
||||||
|
- If C(no), SSL certificates will not be validated.
|
||||||
|
- This should only be used on personally controlled sites using self-signed
|
||||||
|
certificates.
|
||||||
|
default: yes
|
||||||
|
type: bool
|
||||||
|
client_cert:
|
||||||
|
description:
|
||||||
|
- The path to the client certificate (.pfx) that is used for X509
|
||||||
|
authentication. This path can either be the path to the C(pfx) on the
|
||||||
|
filesystem or the PowerShell certificate path
|
||||||
|
C(Cert:\CurrentUser\My\<thumbprint>).
|
||||||
|
- The WinRM connection must be authenticated with C(CredSSP) or C(become)
|
||||||
|
is used on the task if the certificate file is not password protected.
|
||||||
|
- Other authentication types can set I(client_cert_password) when the cert
|
||||||
|
is password protected.
|
||||||
|
type: str
|
||||||
|
client_cert_password:
|
||||||
|
description:
|
||||||
|
- The password for I(client_cert) if the cert is password protected.
|
||||||
|
type: str
|
||||||
|
force_basic_auth:
|
||||||
|
description:
|
||||||
|
- By default the authentication header is only sent when a webservice
|
||||||
|
responses to an initial request with a 401 status. Since some basic auth
|
||||||
|
services do not properly send a 401, logins will fail.
|
||||||
|
- This option forces the sending of the Basic authentication header upon
|
||||||
|
the original request.
|
||||||
|
default: no
|
||||||
|
type: bool
|
||||||
|
url_username:
|
||||||
|
description:
|
||||||
|
- The username to use for authentication.
|
||||||
|
type: str
|
||||||
|
url_password:
|
||||||
|
description:
|
||||||
|
- The password for I(url_username).
|
||||||
|
type: str
|
||||||
|
use_default_credential:
|
||||||
|
description:
|
||||||
|
- Uses the current user's credentials when authenticating with a server
|
||||||
|
protected with C(NTLM), C(Kerberos), or C(Negotiate) authentication.
|
||||||
|
- Sites that use C(Basic) auth will still require explicit credentials
|
||||||
|
through the I(url_username) and I(url_password) options.
|
||||||
|
- The module will only have access to the user's credentials if using
|
||||||
|
C(become) with a password, you are connecting with SSH using a password,
|
||||||
|
or connecting with WinRM using C(CredSSP) or C(Kerberos with delegation).
|
||||||
|
- If not using C(become) or a different auth method to the ones stated
|
||||||
|
above, there will be no default credentials available and no
|
||||||
|
authentication will occur.
|
||||||
|
default: no
|
||||||
|
type: bool
|
||||||
|
use_proxy:
|
||||||
|
description:
|
||||||
|
- If C(no), it will not use the proxy defined in IE for the current user.
|
||||||
|
default: yes
|
||||||
|
type: bool
|
||||||
|
proxy_url:
|
||||||
|
description:
|
||||||
|
- An explicit proxy to use for the request.
|
||||||
|
- By default, the request will use the IE defined proxy unless I(use_proxy)
|
||||||
|
is set to C(no).
|
||||||
|
type: str
|
||||||
|
proxy_username:
|
||||||
|
description:
|
||||||
|
- The username to use for proxy authentication.
|
||||||
|
type: str
|
||||||
|
proxy_password:
|
||||||
|
description:
|
||||||
|
- The password for I(proxy_username).
|
||||||
|
type: str
|
||||||
|
proxy_use_default_credential:
|
||||||
|
description:
|
||||||
|
- Uses the current user's credentials when authenticating with a proxy host
|
||||||
|
protected with C(NTLM), C(Kerberos), or C(Negotiate) authentication.
|
||||||
|
- Proxies that use C(Basic) auth will still require explicit credentials
|
||||||
|
through the I(proxy_username) and I(proxy_password) options.
|
||||||
|
- The module will only have access to the user's credentials if using
|
||||||
|
C(become) with a password, you are connecting with SSH using a password,
|
||||||
|
or connecting with WinRM using C(CredSSP) or C(Kerberos with delegation).
|
||||||
|
- If not using C(become) or a different auth method to the ones stated
|
||||||
|
above, there will be no default credentials available and no proxy
|
||||||
|
authentication will occur.
|
||||||
|
default: no
|
||||||
|
type: bool
|
||||||
|
seealso:
|
||||||
|
- module: community.windows.win_inet_proxy
|
||||||
|
'''
|
Loading…
Reference in a new issue