dsc-konfigurationsuppsättning

Artikel
06/25/2024

Sammanfattning

Framtvingar önskat tillstånd för resursinstanser i ett konfigurationsdokument.

Syntax

Konfigurationsdokument från stdin

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

Konfigurationsdokument från alternativsträng

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

Konfigurationsdokument från fil

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

Beskrivning

Underkommandot set framtvingar det önskade tillståndet för resursinstanserna i ett konfigurationsdokument. När det här kommandot körs validerar DSC konfigurationsdokumentet innan teståtgärden anropas för varje resursinstans som definieras i dokumentet. DSC anropar sedan den angivna åtgärden för varje resursinstans som inte är i önskat tillstånd.

Konfigurationsdokumentet måste skickas till det här kommandot som JSON eller YAML över stdin, som en sträng med alternativet dokument eller från en fil med alternativet sökväg.

Exempel

Exempel 1 – Ange en konfigurations resursinstanser till önskat tillstånd

Kommandot inspekterar de resursinstanser som definierats i konfigurationsdokumentet som sparats som example.dsc.config.yaml och anger dem till önskat tillstånd efter behov.

# 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

Exempel 2 – Skicka en fil som ska läsas som konfigurationsdokument

Kommandot använder alternativet sökväg för att framtvinga konfigurationen som definierats i filen example.dsc.config.yaml.

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

Exempel 3 – Skicka ett konfigurationsdokument som en variabel

Kommandot använder alternativet dokument för att framtvinga konfigurationen som lagras i variabeln $desired.

dsc config set --document $desired

Alternativ

-d, --document

Anger konfigurationsdokumentet för att framtvinga tillstånd för. Dokumentet måste vara en sträng som innehåller ett JSON- eller YAML-objekt. DSC validerar dokumentet mot konfigurationsdokumentschemat. Om verifieringen misslyckas genererar DSC ett fel.

Det här alternativet kan inte användas med konfigurationsdokument över stdin eller alternativet --path. Välj om du vill skicka konfigurationsdokumentet till kommandot över stdin, från en fil med alternativet --path eller med alternativet --document.

Type:      String
Mandatory: false

-p, --path

Definierar sökvägen till ett konfigurationsdokument för att framtvinga tillstånd för i stället för att skicka dokumentet från stdin eller skicka det som en sträng med alternativet --document. Den angivna filen måste innehålla ett konfigurationsdokument som ett JSON- eller YAML-objekt. DSC validerar dokumentet mot konfigurationsdokumentschemat. Om verifieringen misslyckas, eller om den angivna filen inte finns, genererar DSC ett fel.

Det här alternativet är ömsesidigt uteslutande med alternativet --document. När du använder det här alternativet ignorerar DSC alla indata från stdin.

Type:      String
Mandatory: false

-w, --what-if

När du anger det här flaggaalternativet ändrar DSC inte systemtillståndet med den set åtgärden. I stället returneras utdata som anger hur åtgärden ändrar systemtillstånd när den anropas utan det här alternativet. Använd det här alternativet om du vill förhandsgranska de ändringar som DSC kommer att göra i ett system.

Utdata för kommandot när du använder det här alternativet är samma som utan, förutom att fältet ExecutionType metadata är inställt på WhatIf i stället för Actual.

Type:      Boolean
Mandatory: false

-f, --format

Alternativet --format styr konsolens utdataformat för kommandot. Om kommandoutdata omdirigeras eller avbildas som en variabel är utdata alltid JSON.

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

-h, --help

Visar hjälpen för det aktuella kommandot eller underkommandot. När du anger det här alternativet ignorerar programmet alla alternativ och argument efter det här alternativet.

Type:      Boolean
Mandatory: false

Utdata

Det här kommandot returnerar JSON-utdata som innehåller om åtgärden eller några resurser har genererat några fel, samlingen av meddelanden som genererats under åtgärden och resultatet av den angivna åtgärden för varje instans. Mer information finns i dsc config get result schema.

Dela via