conjunto de configurações do dsc

Artigo
06/25/2024

Sinopse

Impõe o estado desejado das instâncias de recurso em um documento de configuração.

Sintaxe

Documento de configuração do stdin

<document-string> | dsc config set [Options]

Documento de configuração da cadeia de caracteres de opção

dsc config set [Options] --document <document-string>

Documento de configuração do arquivo

dsc config set [Options] --path <document-filepath>

Descrição

O subcomando set impõe o estado desejado das instâncias de recurso em um documento de configuração. Quando esse comando é executado, o DSC valida o documento de configuração antes de invocar a operação de teste para cada instância de recurso definida no documento. Em seguida, o DSC invoca a operação definida para cada instância de recurso que não está no estado desejado.

O documento de configuração deve ser passado para esse comando como JSON ou YAML sobre stdin, como uma cadeia de caracteres com a opção de documento ou de um arquivo com a opção caminho .

Exemplos

Exemplo 1 – Definir as instâncias de recurso de uma configuração para o estado desejado

O comando inspeciona as instâncias de recurso definidas no documento de configuração salvas como example.dsc.config.yaml e as define para o estado desejado, conforme necessário.

# example.dsc.config.yaml
$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config set

Exemplo 2 - Passando um arquivo para ler como o documento de configuração

O comando usa a opção caminho para impor a configuração definida no arquivo example.dsc.config.yaml.

dsc config set --path ./example.dsc.config.yaml

Exemplo 3 - Passando um documento de configuração como uma variável

O comando usa a opção documento para impor a configuração armazenada na variável $desired.

dsc config set --document $desired

Opções

-d, --document

Especifica o documento de configuração para o qual impor o estado. O documento deve ser uma cadeia de caracteres que contém um objeto JSON ou YAML. O DSC valida o documento no esquema do documento de configuração. Se a validação falhar, o DSC gerará um erro.

Essa opção não pode ser usada com o documento de configuração por stdin ou a opção --path. Escolha se deve passar o documento de configuração para o comando por stdin, em um arquivo com a opção --path ou com a opção --document.

Type:      String
Mandatory: false

-p, --path

Define o caminho para um documento de configuração para impor o estado em vez de canalizar o documento do stdin ou passá-lo como uma cadeia de caracteres com a opção --document. O arquivo especificado deve conter um documento de configuração como um objeto JSON ou YAML. O DSC valida o documento no esquema do documento de configuração. Se a validação falhar ou se o arquivo especificado não existir, o DSC gerará um erro.

Essa opção é mutuamente exclusiva com a opção --document. Quando você usa essa opção, o DSC ignora qualquer entrada do stdin.

Type:      String
Mandatory: false

-w, --what-if

Quando você especifica essa opção de sinalizador, o DSC não altera o estado do sistema com a operação de set. Em vez disso, retorna uma saída que indica como a operação alterará o estado do sistema quando chamada sem essa opção. Use essa opção para visualizar as alterações que o DSC fará em um sistema.

A saída do comando quando você usa essa opção é a mesma que sem, exceto que o campo de metadados ExecutionType está definido como WhatIf em vez de Actual.

Type:      Boolean
Mandatory: false

-f, --format

A opção --format controla o formato de saída do console para o comando. Se a saída do comando for redirecionada ou capturada como uma variável, a saída será sempre JSON.

Type:         String
Mandatory:    false
DefaultValue: yaml
ValidValues:  [json, pretty-json, yaml]

-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

Saída

Esse comando retorna a saída JSON que inclui se a operação ou quaisquer recursos geraram erros, a coleção de mensagens emitidas durante a operação e os resultados da operação definida para cada instância. Para obter mais informações, consulte dsc config get result schema.

Compartilhar via