Configuração do DSC

Sinopse

Aplique um documento de configuração.

Sintaxe

dsc config [Options] <COMMAND>

Descrição

O dsc config comando inclui subcomandos para gerenciar as instâncias de recursos definidas em um documento de configuração DSC. Para gerenciar recursos diretamente, consulte o comando dsc resource .

Comandos

exportar

O export comando gera um documento de configuração que define as instâncias existentes de um conjunto de recursos. Para obter mais informações, consulte dsc config export.

obter

O get comando recupera o estado atual das instâncias de recurso em um documento de configuração. Para obter mais informações, consulte dsc config get.

conjunto/configuração

O set comando impõe o estado desejado das instâncias de recurso em um documento de configuração. Para obter mais informações, consulte dsc config set.

testar

O test comando verifica se as instâncias de recurso em um documento de configuração estão no estado desejado. Para obter mais informações, consulte dsc config test.

Ajuda

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

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

dsc config help [<SUBCOMMAND>]

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

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

Opções

-f, --parâmetros-arquivo

Especifica o caminho para um arquivo de dados que contém os parâmetros a serem passados para a configuração como JSON ou YAML. Quando você especifica essa opção, o DSC interpreta as chaves no arquivo de dados como parâmetros e usa os valores especificados. Os valores no arquivo de dados substituem quaisquer padrões definidos na própria configuração.

O arquivo de dados deve conter um objeto com a parameters chave. O valor da parameters chave deve ser um objeto onde cada chave é o nome de um parâmetro definido e cada valor é um valor válido para esse parâmetro.

Esta opção exclui-se mutuamente com a --parameters opção.

A partir da versão 3.1.0 do DSC, você pode passar os dados dos parâmetros para um subcomando sobre stdin. Quando o fizer, você deve passar o documento de configuração como uma cadeia de caracteres de entrada ou o caminho para um arquivo no sistema. Não é possível passar o arquivo de parâmetros e o documento de configuração para um comando do stdin.

Para obter mais informações sobre como definir parâmetros em um documento de configuração, consulte Esquema de parâmetros do documento de configuração DSC. Para obter mais informações sobre como usar parâmetros no documento de configuração, consulte a referência da função parameters.

Type        : string
Mandatory   : false
LongSyntax  : --parameters-file <PARAMETERS_FILE>
ShortSyntax : -f <PARAMETERS_FILE>

-p, --parâmetros

Especifica os parâmetros a serem passados para o documento de configuração como uma cadeia de caracteres de dados formatados como JSON ou YAML. Quando você especifica essa opção, o DSC interpreta as chaves na cadeia de dados como parâmetros e usa os valores especificados. Os valores na cadeia de dados substituem quaisquer padrões definidos no próprio documento de configuração.

A cadeia de caracteres de dados deve conter um objeto com a parameters chave. O valor da parameters chave deve ser um objeto onde cada chave é o nome de um parâmetro definido e cada valor é um valor válido para esse parâmetro.

Esta opção exclui-se mutuamente com a --parameters_file opção.

Para obter mais informações sobre como definir parâmetros em um documento de configuração, consulte Esquema de parâmetros do documento de configuração DSC. Para obter mais informações sobre como usar parâmetros no documento de configuração, consulte a referência da função parameters.

Type        : string
Mandatory   : false
LongSyntax  : --parameters <PARAMETERS>
ShortSyntax : -p <PARAMETERS>

-r, --raiz-do-sistema

Use esta opção para especificar o caminho para a raiz do sistema operacional quando você não estiver visando o sistema operacional em execução atual.

Type        : string
Mandatory   : false
LongSyntax  : --system-root <SYSTEM_ROOT>
ShortSyntax : -r <SYSTEM_ROOT>

-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

Os dsc config * subcomandos criam a DSC_CONFIG_ROOT variável de ambiente quando você chama um comando com a --path opção de especificar o documento de configuração a ser usado para o comando. O DSC define o valor da variável de DSC_CONFIG_ROOT ambiente para o caminho completo da pasta que contém o documento de configuração especificado.

Você pode usar a função de configuração envvar para fazer referência a esse caminho de pasta para instâncias de recursos na configuração.