Unarchive

5 min

Resumo

O unarchive módulo descompacta um arquivo. Ele não descompactará um arquivo compactado que não contenha um arquivo.
Por padrão, ele copiará o arquivo de origem do sistema local para o destino antes de descompactar.
Defina remote_src=yes para descompactar um arquivo que já existe no destino.
Para destinos Windows, use o módulo community.windows.win_unzip .

Parâmetros

Chave	Tipo	Retornado quando	Descrição
attributes	string		Os atributos que o arquivo ou diretório resultante deve ter. Para obter os sinalizadores suportados, consulte a página do manual do chattr no sistema de destino. Essa string deve conter os atributos na mesma ordem que aquela exibida por lsattr . O operador = é assumido como padrão, caso contrário, + ou - os operadores precisam ser incluídos na string.
copy	boolean	Escolhas: - false - true(default)	Se verdadeiro, o arquivo é copiado do 'mestre' local para a máquina de destino, caso contrário, o plugin irá procurar o arquivo src na máquina de destino. Esta opção foi substituída por remote_src. Esta opção é mutuamente exclusiva com remote_src.
creates	path		Se o caminho absoluto especificado (arquivo ou diretório) já existir, esta etapa não será executada.
decrypt	boolean	Escolhas: - false - true(default)	Esta opção controla a autodecriptografia de arquivos de origem usando o vault.
dest	path		Caminho absoluto remoto onde o arquivo deve ser descompactado.
exclude	list / elements=string		Liste as entradas de diretório e arquivo que você gostaria de excluir da ação de desarquivar.
extra_opts	string	Default: - ""	Especifique opções adicionais passando uma matriz. Cada opção de linha de comando separada por espaço deve ser um novo elemento da matriz. Veja exemplos. As opções de linha de comando com vários elementos devem usar várias linhas na matriz, uma para cada elemento.
group	string		Nome do grupo que deve possuir o arquivo / diretório, como seria alimentado para chown .
keep_newer	boolean	Escolhas: - false (default) - true	Não substitua os arquivos existentes que são mais recentes do que os arquivos do arquivo.
list_files	boolean	Escolhas: - false (default) - true	Se definido como True, retorna a lista de arquivos contidos no tarball.
mode	raw		As permissões que o arquivo ou diretório resultante deve ter. Para aqueles acostumados com / 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 0644ou 01777) ou citá-lo (como '644'ou '1777') para que Atmosphere receba uma string e possa fazer sua própria conversão de string em número. Fornecer um número a Atmosphere sem seguir uma dessas regras resultará em um número decimal que terá resultados inesperados.
owner	string		Nome do usuário que deve possuir o arquivo / diretório, como seria alimentado para chown .
remote_src	boolean	Escolhas: - false (default) - true	Defina como yespara indicar que o arquivo arquivado já está no sistema remoto e não é local para o controlador Atmosphere. Esta opção é mutuamente exclusiva com copy.
selevel	string		A parte do nível do contexto do arquivo SELinux. Este é o atributo MLS / MCS, também conhecido como range. Quando definido como _default, ele usará a levelparte da política, se disponível.
serole	string		A parte da função do contexto do arquivo SELinux. Quando definido como _default, ele usará a role parte da política, se disponível.
setype	string		A parte do tipo do contexto do arquivo SELinux. Quando definido como _default, ele usará a type parte da política, se disponível.
seuer	string		A parte do usuário do contexto do arquivo SELinux. Por padrão, ele usa a system política, quando aplicável. Quando definido como _default, ele usará a userparte da política, se disponível.
src	string		Se remote_src=no(padrão), caminho local para o arquivo a ser copiado para o servidor de destino; pode ser absoluto ou relativo. Se remote_src=yes, caminho no servidor de destino para o arquivo existente para descompactar. Se remote_src=yes e srccontiver ://, a máquina remota fará o download do arquivo da URL primeiro.
unsafe_writes	boolean	Escolhas: - false (default) - true	Influencie quando usar a operação atômica para evitar corrupção de dados ou leituras inconsistentes do arquivo de destino. Por padrão, este módulo usa operações atômicas para evitar corrupção de dados ou leituras inconsistentes dos arquivos de destino, mas às vezes os sistemas são configurados ou apenas interrompidos de maneiras que evitam isso. Um exemplo são os arquivos montados no docker, que não podem ser atualizados atomicamente de dentro do contêiner e só podem ser gravados de maneira insegura. Esta opção permite que o Atmosphere recorra a métodos não seguros de atualização de arquivos quando as operações atômicas falham (no entanto, não força o Atmosphere a realizar gravações inseguras). IMPORTANTE! As gravações inseguras estão sujeitas a condições de corrida e podem levar à corrupção de dados.
validate_certs	boolean	Escolhas: - false - true(default)	Isso se aplica apenas se estiver usando um URL https como fonte do arquivo. Isso só deve ser definido como nousado em sites controlados pessoalmente com certificado autoassinado.

Notas

Requer zipinfoe gtar/ unzipcomando no host de destino.
Pode manipular arquivos .zip usando unzip, bem como arquivos .tar , .tar.gz , .tar.bz2 e .tar.xz usando gtar.
Não aceita arquivos .gz , arquivos .bz2 ou arquivos .xz que não contenham um arquivo .tar .
Usa o --diffargumento do gtar para calcular se foi alterado ou não. Se isso argnão for compatível, ele sempre descompactará o arquivo.
Os files/diretórios existentes no destino que não estão no arquivo não são tocados. Este é o mesmo comportamento de uma extração de arquivo normal.
Os files/diretórios existentes no destino que não estão no arquivo são ignorados para o propósito de decidir se o arquivo deve ser descompactado ou não.

Exemplos

# Extraia foo.tgz em /var/lib/foo
  unarchive:
    src: foo.tgz
    dest: /var/lib/foo

# Desarquivar um arquivo que já está na máquina remota
  unarchive:
    src: /tmp/foo.zip
    dest: /usr/local/bin
    remote_src: yes

# Desarquivar um arquivo que precisa ser baixado
  unarchive:
    src: https://example.com/example.zip
    dest: /usr/local/bin
    remote_src: yes

# Desarquivar um arquivo com opções extras
  unarchive:
    src: /tmp/foo.zip
    dest: /usr/local/bin
    extra_opts:
    - --transform
    - s/^xxx/yyy/

Valores retornados

Chave	Tipo	Retornado quando	Descrição
changed	boolean	Sempre	Se a operação foi concluída ou não.
extract_results	string	Sempre	Resultados da extração.
files	string	Sempre	Arquivos extraídos.