Share via

dsc

  • Artigo

Sinopse

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

Sintaxe

dsc [Options] <COMMAND>

Comandos

completer

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

config

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

  • Obter 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 config.

recurso

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

  • Listar os recursos disponíveis.
  • Obtenha o esquema JSON para instâncias de um recurso.
  • Obter 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 resource

esquema

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

ajuda

O help comando 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 config subcomando. dsc help config set obtém a 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

-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 essa.

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 na 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, a DSC emite mensagens nesse nível e acima.

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

Aviso

A trace saída de nível emite toda a entrada/saída JSON que o DSC processa durante a execução. A DSC não limpa o JSON antes de emiti-lo. Esse nível de rastreamento destina-se apenas ao uso do desenvolvedor. Nunca redirecione trace a saída de nível para o armazenamento, pois ela pode conter informações confidenciais.

Por exemplo, quando o nível de log é debug, a DSC emite mensagens para cada nível de log, exceto trace. Quando o nível de log é error, a DSC emite apenas mensagens de erro. A 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. A 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 nenhuma cor 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 essa.

Type:      Boolean
Mandatory: false

Variáveis de ambiente

Por padrão, o dsc comando pesquisa manifestos de recurso DSC baseados em comando nas pastas definidas pela PATH variável de ambiente. Se a DSC_RESOURCE_PATH variável de ambiente for definida, dsc pesquisa as 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 que a PATH variável de ambiente para o sistema operacional. Separe caminhos de pasta com ponto e vírgula (;) no 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 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 uma interrupção de Ctrl+C .