Valores de retorno
Os módulos normalmente retornam uma estrutura de dados que pode ser registrada em uma variável, ou vista diretamente quando emitida pelo programa. Cada módulo pode opcionalmente documentar seus próprios valores de retorno exclusivos.
Este documento abrange valores de retorno comuns a todos os módulos checkpoint.
Observação
Algumas dessas chaves podem ser definidas pelo próprio Atmosphere quando ele processa as informações de retorno do módulo.
backup_file
Para os módulos que implementam backup=no|yes ao manipular arquivos, um caminho para o arquivo de backup é criado se o arquivo original foi alterado.
changed
Um booleano que indica se a tarefa teve que fazer alterações no host de destino ou delegado.
diff
Informações sobre diferenças entre o estado anterior e o atual. Geralmente um dicionário com entradas beforee after, que serão então formatados pelo plugin de retorno de chamada para uma visualização diff.
failed
Um booleano que indica se a tarefa falhou ou não.
invocation
Informações sobre como o módulo foi invocado.
msg
Uma sequência de caracteres com uma mensagem genérica retransmitida ao usuário.
rc
Alguns módulos executam utilitários de linha de comando ou são projetados para executar comandos diretamente (raw, shell, command e assim por diante). Este campo contém o 'código de retorno' desses utilitários.
results
Se essa chave existir, ela indica que um loop estava presente para a tarefa e que ela contém uma lista do 'resultado' do módulo normal por item.
skipped
Um booleano que indica se a tarefa foi ignorada ou não
stderr
Alguns módulos executam utilitários de linha de comando ou são projetados para executar comandos diretamente (raw, shell, command e assim por diante). Este campo contém a saída de erro desses utilitários.
stderr_lines
Quando stderr é retornado, também sempre fornecemos este campo, que é uma lista de strings, um item por linha do original.
stdout
Alguns módulos executam utilitários de linha de comando ou são voltados para executar comandos diretamente (raw, shell, command, e assim por diante). Este campo contém a saída normal desses utilitários.
stdout_lines
Quando stdout é retornado, o Atmosphere sempre fornece uma lista de strings, cada uma contendo um item por linha da saída original.
Uso interno
Essas chaves podem ser adicionadas por módulos, mas serão removidas das variáveis registradas; elas são "consumidas" pelo próprio Atmosphere.
atmosphere_facts
Esta chave deve conter um dicionário que será anexado aos fatos atribuídos ao host. Eles serão diretamente acessíveis e não exigem o uso de uma variável registrada.
exception
Esta chave pode conter informações de traceback causadas por uma exceção em um módulo. Ela só será exibida em alta verbosidade (-vvv).
warnings
Esta chave contém uma lista de strings que serão apresentadas ao usuário.
deprecations
Esta chave contém uma lista de dicionários que serão apresentados ao usuário. As chaves dos dicionários são msg e version , os valores são string, o valor para a chave version pode ser uma string vazia.