Gerenciamento de arquivos

13 min

Compress File

Resumo

Cria um arquivo compactado de um ou mais arquivos.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
path - required	list		Caminho absoluto para o arquivo ou arquivos a compactar ou arquivar.
format	string	Escolhas: - tar - zip (default)	O tipo de compactação a ser usado.
dest	path		O nome do arquivo do arquivo de destino. - Isso é necessário quando C (caminho) se refere a vários arquivos, especificando um glob, um diretório ou vários caminhos em uma lista.

Exemplos

# Exemplo: Iniciando compressão do arquivo
- compress_file:
    path: /tests/tests/Documents/Folder
    format: tar
    dest: /tests/tests/Documents

Valores retornados

Chave	Tipo	Retornado quando	Descrição
state	string	Sempre	O estado atual do arquivo arquivado. Se 'ausente', nenhum arquivo de origem foi encontrado e o arquivo não existe. Se 'compactar', o arquivo de origem do arquivo está no estado compactado. Se 'arquivar', o arquivo ou os caminhos de origem estão atualmente arquivados. Se 'incompleto', então um arquivo foi criado, mas nem todos os caminhos de origem foram encontrados.

Read CSV

Resumo

Leia um arquivo CSV e retorne uma lista ou um dicionário, contendo um dicionário por linha.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
delimiter	string		Uma string de um caractere usada para separar campos. Ao usar este parâmetro, você altera o valor padrão usado pelo dialeto. O valor padrão depende do dialeto usado.
dialect	string	- "excel" (default)	O dialeto CSV a ser usado ao ler o arquivo CSV. Os valores possíveis incluem excel, excel-tab ou unix.
fieldnames	list / elements=string		Uma lista de nomes de campo para cada coluna. Isso é necessário se o CSV não tiver um cabeçalho.
key	string		O nome da coluna usado como uma chave para o dicionário resultante. Se a chave não for definida, o módulo retorna uma lista de dicionários, onde cada dicionário é uma linha no arquivo CSV.
path - required aliases: filename	path		O nome do arquivo CSV do qual será lido os dados.
skipinitialspace	boolean	Escolhas: - false - true	Se deve ignorar quaisquer espaços em branco imediatamente após o delimitador. Ao usar este parâmetro, você altera o valor padrão usado pelo dialeto. O valor padrão depende do dialeto usado.
strict	boolean	Escolhas: - false - true	Se deve gerar uma exceção na entrada incorreta do CSV. Ao usar este parâmetro, você altera o valor padrão usado pelo dialeto. O valor padrão depende do dialeto usado.
unique	boolean	Escolhas: - false - true (default)	Se espera-se que a chave usada seja exclusiva.

Exemplos

# Exemplo: Leia os usuários do arquivo CSV e retorne uma lista
- read_csv:
    path: users.csv
    fieldnames: name,uid,gid
    delimiter: ';'

Valores retornados

Chave	Tipo	Retornado quando	Descrição
dict	dictionary	Sucesso	O conteúdo CSV como um dicionário.
list	list / elements=string	Sucesso	O conteúdo CSV como uma lista.

Uncompress File

Resumo

O módulo Uncompress descompacta um arquivo.
Por padrão, ele copiará o arquivo de origem do sistema local para o destino antes de descompactar.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
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 - 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 - required	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 desarquivamento.
extra_opts	list / elements=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 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 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
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 roleparte da política, se disponível.
setype	string		A parte do tipo do contexto do arquivo SELinux.Quando definido como _default, ele usará a typeparte da política, se disponível.
seuser	string		A parte do usuário do contexto do arquivo SELinux.Por padrão, ele usa a systempolítica, quando aplicável.Quando definido como _default, ele usará a userparte da política, se disponível.
src - required	path		Se remote_src=no(default), 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=ye se srccontiver ://, a máquina remota baixará o arquivo do URL primeiro. (version_added 2.0). Isso é apenas para casos simples, para suporte completo de download, use o módulo Atmosphere.builtin.get_url.
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. 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.Antes da versão 2.2, o código funcionava como se estivesse definido como yes.

Exemplos

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

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

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

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