Compartilhar via


Dsc

Sinopse

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

Sintaxe

dsc [Options] <COMMAND>

Comandos

completer

O comando completer retorna um script de shell que, quando executado, registra conclusões para o shell especificado. Para obter mais informações, consulte de concluídor.

configuração

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

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

Para obter mais informações, consulte de configuração.

recurso

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

  • Liste os recursos disponíveis.
  • Obtenha o esquema JSON para as 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 obter mais informações, consulte de recursos

esquema

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

Ajuda

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

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

dsc help <COMMAND> [<SUBCOMMAND>]

Por exemplo, dsc help config obtém a ajuda para o subcomando config. dsc help config set obtém a ajuda para o subcomando config set.

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

-h, --help

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

Type:      Boolean
Mandatory: false

-l, --trace-level

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

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

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

Aviso

A saída de nível trace 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. Esse nível de rastreamento destina-se apenas ao uso do desenvolvedor. Nunca redirecione trace saída de nível para o armazenamento, pois ela pode conter informações confidenciais.

Por exemplo, quando o nível de log é debug, o DSC emite mensagens para cada nível de log, exceto trace. Quando o nível de log é error, o DSC emite apenas mensagens de erro. O DSC ignora todas as mensagens com um nível de log inferior.

Type:         String
Mandatory:    false
DefaultValue: warning
ValidValues:  [error, warning, info, debug, trace]

-f, --trace-format

Define o formato de saída a ser usado ao emitir mensagens de rastreamento no stderr. O DSC dá suporte aos seguintes formatos:

  • default - Emite a mensagem com a coloração do console ANSI para o carimbo de data/hora, o nível da mensagem e o número de linha.
  • plaintext - Como default mas sem cores de console.
  • json – emite cada mensagem como um objeto JSON compactado com o carimbo de data/hora, o nível, a mensagem e o número de linha como propriedades.
Type:         String
Mandatory:    false
DefaultValue: default
ValidValues:  [default, plaintext, json]

-V, --version

Exibe a versão do aplicativo. Quando você especifica essa opção, o aplicativo ignora todas as opções e argumentos após esta.

Type:      Boolean
Mandatory: false

Variáveis de ambiente

Por padrão, o comando dsc pesquisa manifestos de recurso DSC baseados em comando nas pastas definidas pela variável de ambiente PATH. Se a variável de ambiente DSC_RESOURCE_PATH for definida, dsc pesquisará as pastas em DSC_RESOURCE_PATH em vez de PATH.

O ambiente DSC_RESOURCE_PATH deve ser uma variável de ambiente que siga as mesmas convenções que a variável de ambiente PATH para o sistema operacional. Separar caminhos de pasta com um ponto-e-vírgula (;) no Windows e dois-pontos (:) em outras plataformas.

Códigos de saída

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

Sair do código Significado
0 O comando foi executado com êxito 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 pôde ser serializado ou desserializado do JSON.
4 O comando falhou porque a entrada para o comando não era YAML ou JSON válida.
5 O comando falhou porque uma definição de recurso ou valor de instância era inválido em relação ao esquema JSON.
6 O comando foi cancelado por um ctrl+interrupção do C.

Anotações

O DSC espera que as cadeias de caracteres de entrada usem a codificação UTF-8. Ao passar a entrada do stdin ou do caminho para um arquivo, verifique se a entrada está codificada como UTF-8.