Get Url

4 min

Resumo

Baixa arquivos de HTTP, HTTPS ou FTP de um servidor remoto.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
backup	boolean	Escolhas: - false (default) - true	Crie um arquivo de backup incluindo as informações do carimbo de data/hora para que você possa obter o arquivo original de volta se, de alguma forma, o danificou incorretamente.
checksum	string	- ' ' (default)	Se uma soma de verificação for passada para esse parâmetro, o resumo do arquivo de destino será calculado após o download para garantir sua integridade e verificar se a transferência foi concluída com êxito. Por exemplo checksum = "sha256: D98291ACB6DC7B97", checksum = "sha256: http: //example.com/path/sha256sum.txt". Além disso, se uma soma de verificação for passada para este parâmetro e o arquivo existir no local dest, a soma de destino será calculada e, se a soma de verificação for igual a soma de verificação de destino, o arquivo o download será ignorado (a menos que force seja true). Se a soma de verificação não for igual a destination_checksum, o arquivo de destino será excluído.
client_cert	path		Arquivo de cadeia de certificados formatado em PEM a ser usado para autenticação de cliente SSL. Esse arquivo também pode incluir a chave e, se a chave estiver incluída, client_key não é necessária.
client_key	path		Arquivo formatado PEM que contém sua chave privada a ser usada para autenticação de cliente SSL. Se client_cert conter o certificado e a chave, esta opção não é necessária.
dest - required	path		Caminho absoluto de onde fazer o download do arquivo. Se dest for um diretório, será usado o nome do arquivo fornecido pelo servidor ou, se nenhum for fornecido, o nome base da URL no servidor remoto será usado. Se for um diretório, force também não terá efeito e, o arquivo sempre será baixado (independentemente da opção force), mas substituído apenas se o conteúdo for alterado.
force aliases: thirsty	boolean	Escolhas: - false (default) - true	Se true e dest não for um diretório, baixará o arquivo todas as vezes, e substituirá o arquivo se o conteúdo mudar. Se não, o arquivo só será baixado se o destino não existir. Geralmente deve ser true apenas para pequenos arquivos locais.
force_basic_auth	boolean	Escolhas: - false (default) - true	Força o envio do cabeçalho de autenticação básica na solicitação inicial. httplib2, a biblioteca usada pelo módulo uri, apenas envia informações de autenticação quando um serviço da web responde a uma solicitação inicial com um status 401. Como alguns serviços básicos de autenticação não enviam corretamente um 401, os logins falharão.
headers	dictionary		Adicione cabeçalhos HTTP personalizados a uma solicitação no formato hash/dict.
http_agent	string	- "atmosphere-httpget" (default)	Cabeçalho para identificar como geralmente aparece nos logs do servidor web.
mode	raw		As permissões que o arquivo ou diretório resultante deve ter. Para aqueles usados para /usr/bin/chmod, lembre-se de que os modos são, na verdade, números octais. Você deve adicionar um zero à esquerda para que o analisador YAML do Atmosphere saiba que é um número octal (como 0644 ou 01777) ou citá-lo (como '644' ou '1777') para que o Atmosphere receba uma string e possa fazer sua própria conversão da string em número. Dar ao Atmosphere um número sem seguir uma dessas regras terminará com um número decimal que terá resultados inesperados.
sha256sum	string	- ' ' (default)	Se uma soma de verificação SHA-256 for passada para este parâmetro, o resumo do arquivo de destino será calculado após o download para garantir sua integridade e verificar se a transferência foi concluída com êxito.
timeout	integer	- 10 (default)	Tempo limite em segundos para solicitação de URL.
tmp_dest	path		Caminho absoluto de onde o arquivo temporário é baixado.
url - required	string		URL HTTP, HTTPS ou FTP no formato: (http\|https\|ftp)://[user[:pass]]@host.domain[:port]/path
url_password aliases: password	string		A senha para uso na autenticação básica HTTP. Se o parâmetro url_username não for especificado, o parâmetro url_password não será usado.
url_username aliases: username	string		O nome de usuário para uso na autenticação HTTP básica. Este parâmetro pode ser usado sem url_password para sites que permitem senhas vazias.
use_proxy	boolean	Escolhas: - false - true (default)	Se false, ele não usará um proxy, mesmo se um estiver definido em uma variável de ambiente nos hosts de destino.
validate_certs	boolean	Escolhas: - false - true (default)	Se false, os certificados SSL não serão validados. Isso só deve ser usado em sites controlados pessoalmente por meio de certificados autoassinados.

Exemplos

# Exemplo: Baixar um arquivo
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    mode: '0440'

# Exemplo: Baixar um arquivo e forçar a autenticação básica
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    force_basic_auth: true

# Exemplo: Baixar um arquivo com cabeçalhos HTTP personalizados
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    headers:
      key1: one
      key2: two

# Exemplo: Baixar um arquivo com verificação (sha256)
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    checksum: sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c

# Exemplo: Baixar um arquivo com verificação (md5)
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    checksum: md5:66dffb5228a211e61d6d7ef4a86f5758

# Exemplo: Baixar um arquivo com checksum de url(sha256)
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    checksum: sha256:http://example.com/path/sha256sum.txt

# Exemplo: Baixar o arquivo de um caminho de arquivo
- get_url:
    url: file:///tmp/afile.txt
    dest: /tmp/afilecopy.txt

# Exemplo: Busca um arquivo que requer autenticação
- get_url:
    url: http://example.com/path/file.conf
    dest: /etc/foo.conf
    username: bar
    password: '{{ mysecret }}'

Valores retornados

Chave	Tipo	Retornado quando	Descrição
backup_file	string	Estiver mudado e backup for true	Nome do arquivo de backup criado após o download.
checksum_dest	string	Sucesso	Checksum sha1 do arquivo após a cópia.
checksum_src	string	Sucesso	Checksum sha1 do arquivo.
dest	string	Sucesso	Arquivo/caminho de destino.
elapsed	integer	Sempre	O número de segundos decorridos durante a realização do download.
gid	integer	Sucesso	ID do grupo do arquivo.
group	string	Sucesso	Grupo do arquivo.
md5sum	string	Quando suportado	Checksum md5 do arquivo após o download.
mode	string	Sucesso	Permissões do alvo.
msg	string	Sempre	A mensagem HTTP da requisição.
owner	string	Sucesso	Dono do arquivo.
secontext	string	Sucesso	O contexto de segurança SELinux do arquivo.
size	integer	Sucesso	Tamanho do arquivo alvo.
src	string	Sempre	Arquivo fonte usado após o download.
state	string	Sucesso	Estado do arquivo alvo.
status_code	integer	Sempre	O código de status HTTP da solicitação
uid	integer	Sucesso	ID do proprietário do arquivo, após a execução.
url	string	Sempre	O URL usado para a solicitação.