dsc-konfigurationstest

Artikel
06/24/2024

Synopsis

Verifierar om resursinstanserna i ett konfigurationsdokument är i önskat tillstånd.

Syntax

Konfigurationsdokument från stdin

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

Konfigurationsdokument från alternativsträng

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

Konfigurationsdokument från fil

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

Description

Underkommandot test verifierar om resursinstanserna i ett konfigurationsdokument är i önskat tillstånd. När det här kommandot körs validerar DSC konfigurationsdokumentet innan teståtgärden anropas för varje resursinstans som definieras i dokumentet.

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

Exempel

Exempel 1 – Testa om en konfigurations resursinstanser är i önskat tillstånd

Kommandot returnerar status, önskat tillstånd, faktiskt tillstånd och olika egenskaper för de resursinstanser som definierats i konfigurationsdokumentet som sparats som example.dsc.config.yaml.

# 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 test

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

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

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

Exempel 3 – Skicka ett konfigurationsdokument som en variabel

Kommandot använder dokumentalternativet för att verifiera konfigurationen som lagras i variabeln $desired .

dsc config test --document $desired

Alternativ

-d, --document

Anger konfigurationsdokumentet som tillståndet ska valideras för. Dokumentet måste vara en sträng som innehåller ett JSON- eller YAML-objekt. DSC verifierar dokumentet mot konfigurationsdokumentets schema. Om verifieringen misslyckas genererar DSC ett fel.

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

Type:      String
Mandatory: false

-p, --path

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

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

Type:      String
Mandatory: false

-f, --format

Alternativet --format styr konsolens utdataformat för kommandot. Om kommandots utdata 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 resurser har utlöst några fel, samlingen av meddelanden som genereras under åtgärden och teståtgärdsresultatet för varje instans. Mer information finns i schema för dsc-konfigurationstestresultat.

Dela via