dsc

Sinopse

Aplique configuração ou invoque recursos específicos para gerenciar componentes de software.

Sintaxe

dsc [Options] <COMMAND>

Comandos

Concluído

O completer comando retorna um script de shell que, quando executado, registra as conclusãos para o shell dado. Para mais informações, veja dsc completer.

config

O config comando gerencia um documento de Configuração DSC. Você pode usá-lo para:

  • Veja o estado atual da configuração.
  • Teste se uma configuração está no estado desejado.
  • Defina uma configuração para o estado desejado.

Para mais informações, veja configuração dsc.

recurso

O resource comando gerencia um Recurso DSC. Você pode usá-lo para:

  • Liste os recursos disponíveis.
  • Obtenha o esquema JSON das instâncias de um recurso.
  • Obtenha o estado atual de uma instância de recurso.
  • Teste se uma instância de recurso está no estado desejado.
  • Defina uma instância de recurso para o estado desejado.

Para mais informações, consulte o recurso dsc

esquema

O schema comando retorna o esquema JSON para um tipo específico de DSC. Para mais informações, veja esquema dsc.

ajuda

O help comando retorna informações de ajuda para dsc, um comando ou um subcomando.

Para obter ajuda para um comando ou subcomando, use a sintaxe:

dsc help <COMMAND> [<SUBCOMMAND>]

Por exemplo, dsc help config recebe ajuda para o config subcomando. dsc help config set Recebe ajuda para o config set subcomando.

Você também pode usar a opção --help em um comando para exibir as informações de ajuda. Por exemplo, dsc config --help ou dsc config set --help.

Opções

-l, --nível de traço

Define o nível mínimo de mensagem que o DSC deve emitir durante uma operação. As mensagens no DSC são categorizadas pelo seu nível.

A lista a seguir mostra os níveis válidos de mensagem do nível mais alto ao mais baixo. Quando essa opção é definida para qualquer valor na lista, o DSC emite mensagens nesse nível e acima.

  • error
  • warn (padrão)
  • info
  • debug
  • trace

Warning

A trace saída do nível emite toda a entrada/saída JSON que o DSC processa durante a execução. O DSC não higieniza o JSON antes de emiti-lo. Este nível de rastreamento é destinado apenas ao uso por desenvolvedores. Nunca redirecione trace a saída de nível para o armazenamento, pois pode conter informações sensíveis.

Por exemplo, quando o nível logarítmico é debug, o DSC emite mensagens para todo nível logarítmico, exceto trace. Quando o nível do log é error, o DSC emite apenas mensagens de erro. O DSC ignora todas as mensagens com nível logaritário menor.

Type         : string
Mandatory    : false
DefaultValue : warn
ValidValues  : [error, warn, info, debug, trace]
LongSyntax   : --trace-level <TRACE_LEVEL>
ShortSyntax  : -l <TRACE_LEVEL>

-f, --formato de traço

Define o formato de saída a ser usado ao emitir mensagens de rastreamento no stderr. O DSC suporta os seguintes formatos:

  • default - Emite a mensagem com coloração do console ANSI para o carimbo de data, nível da mensagem e número de linha.
  • plaintext - Porém default , sem nenhuma cor de console.
  • json - Emite cada mensagem como um objeto JSON comprimido com o carimbo de data, nível, mensagem e número de linha como propriedades.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --progresso-formato

Define o formato de progresso a ser usado ao emitir mensagens de progresso no stderr. O DSC suporta os seguintes formatos:

  • default - Mostra uma barra de progresso se o DSC detectar que está sendo chamado interativamente. Caso contrário, o DSC não mostra progresso.
  • none - Não mostra progresso.
  • json - Emite progresso como objetos JSON comprimidos com carimbo de tempo, nível, mensagem e número de linha como propriedades.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --versão

Exibe a versão da aplicação. Quando você especifica essa opção, a aplicação ignora todas as opções e argumentos, exceto --help, que sobrepõe essa opção.

Type        : boolean
Mandatory   : false
LongSyntax  : --version
ShortSyntax : -V

-h, --ajuda

Exibe a ajuda para o comando ou subcomando atual. Quando você especifica essa opção, o aplicativo ignora todas as outras opções e argumentos.

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Variáveis de ambiente

Por padrão, o dsc comando busca manifestos de recursos DSC nas pastas definidas pela PATH variável ambiente. Se a DSC_RESOURCE_PATH variável ambiente estiver definida, dsc busca nas pastas em DSC_RESOURCE_PATH vez de PATH.

O DSC_RESOURCE_PATH ambiente deve ser uma variável de ambiente que siga as mesmas convenções da PATH variável de ambiente do sistema operacional. Caminhos separados de pastas com ponto e vírgula (;) em Windows e dois-pontos (:) em outras plataformas.

Códigos de saída

O dsc comando usa códigos de saída semânticos. Cada código de saída representa um resultado diferente para a execução do comando.

Código de Saída Meaning
0 O comando foi executado com sucesso, sem erros.
1 O comando falhou porque recebeu argumentos inválidos.
2 O comando falhou porque um recurso gerou um erro.
3 O comando falhou porque um valor não podia ser serializado ou desserializado do JSON.
4 O comando falhou porque a entrada para o comando não era válida em YAML ou JSON.
5 O comando falhou porque uma definição de recurso ou valor de instância era inválido contra seu esquema JSON.
6 O comando foi cancelado por uma interrupção Ctrl+C .

Notes

O DSC espera que as strings de entrada usem codificação UTF-8. Quando você passar a entrada do stdin ou do caminho para um arquivo, certifique-se de que a entrada esteja codificada como UTF-8.