Nota

Este complemento es parte del colección ansible.windows (versión 1.3.0).

Para instalarlo use: ansible-galaxy collection install ansible.windows.

Para usarlo en un libro de jugadas, especifique: ansible.windows.win_get_url.

  • Sinopsis
  • Parámetros
  • Notas
  • Ver también
  • Ejemplos de
  • Valores devueltos

Sinopsis

  • Descarga archivos de HTTP, HTTPS o FTP al servidor remoto.
  • El servidor remoto debe tener acceso directo al recurso remoto.
  • Para destinos que no son de Windows, use el ansible.builtin.get_url módulo en su lugar.

Parámetros

Parámetro Opciones / Valores predeterminados Comentarios
suma de comprobacióncuerda Si un suma de comprobación se pasa a este parámetro, el resumen del archivo de destino se calculará después de que se descargue para garantizar su integridad y verificar que la transferencia se haya completado correctamente. Esta opción no se puede configurar con checksum_url.
checksum_algorithmcuerda
    Opciones:

  • md5
  • sha1 ←
  • sha256
  • sha384
  • sha512
 Especifica el algoritmo hash utilizado al calcular la suma de comprobación del archivo remoto y de destino.
checksum_urlcuerda Especifica una URL que contiene los valores de suma de comprobación para el recurso en url.Igual que checksum, esto se utiliza para verificar la integridad de la transferencia remota. Esta opción no se puede configurar con suma de comprobación.
client_certcuerda La ruta al certificado de cliente (.pfx) que se usa para la autenticación X509. Este camino puede ser el camino al pfx en el sistema de archivos o en la ruta del certificado de PowerShell Cert:CurrentUserMy.La conexión WinRM debe autenticarse con CredSSP o become se utiliza en la tarea si el archivo de certificado no está protegido con contraseña. Se pueden establecer otros tipos de autenticación client_cert_password cuando el certificado está protegido con contraseña.
client_cert_passwordcuerda La contraseña para client_cert si el certificado está protegido con contraseña.
destsendero / requerido La ubicación para guardar el archivo en la URL. Asegúrese de incluir un nombre de archivo y una extensión según corresponda.
follow_redirectscuerda
    Opciones:

  • todos
  • ninguno
  • a salvo ←
 Si el módulo debe seguir redireccionamientos.all Seguirá todas las redirecciones.none no seguirá ninguna redirección.safe seguirá solo redireccionamientos “seguros”, donde “seguro” significa que el cliente solo está haciendo un GET o HEAD en la URI a la que se está redirigiendo. Cuando se sigue una URL redirigida, Authorization El encabezado y las credenciales establecidas se eliminarán y no se redirigirán.
fuerzabooleano
    Opciones:

  • no
  • sí ←
 Si yes, descargará el archivo cada vez y reemplazará el archivo si el contenido cambia. Si no, solo descargará el archivo si no existe o si el archivo remoto se ha modificado más recientemente que el archivo local. Esto funciona enviando una solicitud http HEAD para recuperar la última hora de modificación del recurso solicitado, por lo que para que esto funcione, el El servidor web remoto debe admitir solicitudes HEAD.
force_basic_authbooleano
    Opciones:

  • no ←
  • sí
 De forma predeterminada, el encabezado de autenticación solo se envía cuando un servicio web responde a una solicitud inicial con un estado 401. Dado que algunos servicios de autenticación básica no envían correctamente un 401, los inicios de sesión fallarán. Esta opción fuerza el envío del encabezado de autenticación básica en la solicitud original.
encabezadosdiccionario Encabezados adicionales para configurar en la solicitud. Debe ser un diccionario donde la clave es el nombre del encabezado y el valor es el valor para ese encabezado.
http_agentcuerda Defecto:
“ansible-httpget”		 El encabezado para identificar como, generalmente aparece en los registros del servidor web. User-Agent encabezado en una solicitud HTTP.
redireccion_máximaentero Defecto:
50		 Especifique cuántas veces el módulo redirigirá una conexión a un URI alternativo antes de que falle la conexión. 0 o follow_redirects se establece en none, o safe cuando no está haciendo un GET o HEAD evita toda redirección.
proxy_passwordcuerda La contraseña para proxy_username.
proxy_urlcuerda Un proxy explícito para usar en la solicitud De forma predeterminada, la solicitud usará el proxy definido por IE a menos que usa proxy se establece en no.
proxy_use_default_credentialbooleano
    Opciones:

  • no ←
  • sí
 Utiliza las credenciales del usuario actual cuando se autentica con un host proxy protegido con NTLM, Kerberos, o Negotiate autenticación Proxies que utilizan Basic auth aún requerirá credenciales explícitas a través del proxy_username y proxy_password El módulo solo tendrá acceso a las credenciales del usuario si usa become con una contraseña, se está conectando con SSH usando una contraseña, o se está conectando con WinRM usando CredSSP o Kerberos with delegation.Si no está usando become o un método de autenticación diferente a los indicados anteriormente, no habrá credenciales predeterminadas disponibles y no ocurrirá autenticación de proxy.
proxy_usernamecuerda El nombre de usuario que se utilizará para la autenticación de proxy.
urlcuerda / requerido La URL completa de un archivo para descargar.
url_methodcuerda El método HTTP de la solicitud.
alias: método
url_passwordcuerda La contraseña para url_username.El alias contraseña está en desuso y se eliminará en la versión principal después de 2022-07-01.
alias: contraseña
url_timeoutentero Defecto:
30		 Especifica cuánto tiempo puede estar pendiente la solicitud antes de que se agote (en segundos). 0 para especificar un tiempo de espera infinito.
alias: tiempo de espera
url_usernamecuerda El nombre de usuario que se utilizará para la autenticación. usuario y nombre de usuario está en desuso y se eliminará en la versión principal después de 2022-07-01.
alias: usuario, nombre de usuario
use_default_credentialbooleano
    Opciones:

  • no ←
  • sí
 Utiliza las credenciales del usuario actual cuando se autentica con un servidor protegido con NTLM, Kerberos, o Negotiate autenticación.Sitios que utilizan Basic auth aún requerirá credenciales explícitas a través del url_username y url_password El módulo solo tendrá acceso a las credenciales del usuario si usa become con una contraseña, se está conectando con SSH usando una contraseña, o se está conectando con WinRM usando CredSSP o Kerberos with delegation.Si no está usando become o un método de autenticación diferente a los indicados anteriormente, no habrá credenciales predeterminadas disponibles y no se producirá ninguna autenticación.
usa proxybooleano
    Opciones:

  • no
  • sí ←
 Si no, no utilizará el proxy definido en IE para el usuario actual.
validate_certsbooleano
    Opciones:

  • no
  • sí ←
 Si no, Los certificados SSL no serán validados. Esto solo debe usarse en sitios controlados personalmente que utilicen certificados autofirmados.

Notas

Nota

  • Si su URL incluye un carácter de barra de escape (% 2F), este módulo lo convertirá en una barra real. Este es el resultado del comportamiento de la clase System.Uri como se describe en la documentación.

Ver también

Ver también

ansible.builtin.get_url

La documentación oficial sobre el ansible.builtin.get_url módulo.

ansible.builtin.uri

La documentación oficial sobre el ansible.builtin.uri módulo.

ansible.windows.win_uri

La documentación oficial sobre el ansible.windows.win_uri módulo.

community.windows.win_inet_proxy

La documentación oficial sobre el community.windows.win_inet_proxy módulo.

Ejemplos de

-name: Download earthrise.jpg to specified path
  ansible.windows.win_get_url:url: http://www.example.com/earthrise.jpg
    dest: C:UsersRandomUserearthrise.jpg

-name: Download earthrise.jpg to specified path only if modified
  ansible.windows.win_get_url:url: http://www.example.com/earthrise.jpg
    dest: C:UsersRandomUserearthrise.jpg
    force: no

-name: Download earthrise.jpg to specified path through a proxy server.
  ansible.windows.win_get_url:url: http://www.example.com/earthrise.jpg
    dest: C:UsersRandomUserearthrise.jpg
    proxy_url: http://10.0.0.1:8080proxy_username: username
    proxy_password: password

-name: Download file from FTP with authentication
  ansible.windows.win_get_url:url: ftp://server/file.txt
    dest:'%TEMP%ftp-file.txt'url_username: ftp-user
    url_password: ftp-password

-name: Download src with sha256 checksum url
  ansible.windows.win_get_url:url: http://www.example.com/earthrise.jpg
    dest: C:tempearthrise.jpg
    checksum_url: http://www.example.com/sha256sum.txt
    checksum_algorithm: sha256
    force:True-name: Download src with sha256 checksum url
  ansible.windows.win_get_url:url: http://www.example.com/earthrise.jpg
    dest: C:tempearthrise.jpg
    checksum: a97e6837f60cec6da4491bab387296bbcd72bdba
    checksum_algorithm: sha1
    force:True

Valores devueltos

Los valores de retorno comunes están documentados aquí, los siguientes son los campos exclusivos de este módulo:

Llave Devuelto Descripción
checksum_destcuerda éxito y dest se han descargado suma de comprobación del archivo después de la descarga
Muestra:6e642bb8dd5c2e027bf21dd923337cbb4214f827
checksum_srccuerda force = yes o dest no existía suma de comprobación del recurso remoto
Muestra:6e642bb8dd5c2e027bf21dd923337cbb4214f827
destcuerda siempre archivo / ruta de destino
Muestra:C: Users RandomUser earthrise.jpg
transcurridoflotador siempre Los segundos transcurridos entre el inicio de la encuesta y el final del módulo.
Muestra:2.1406487
msgcuerda siempre Mensaje de error o mensaje de estado HTTP de Servidor web
Muestra:OK
Tallaentero éxito tamaño del archivo dest
Muestra:1220
código de estadoentero siempre Código de estado HTTP
Muestra:200
urlcuerda siempre URL solicitada
Muestra:http://www.example.com/earthrise.jpg

Autores

  • Paul Durivage (@angstwad)
  • Takeshi Kuramochi (@tksarah)