dsc konfigurációs teszt

Áttekintés

Ellenőrzi, hogy a konfigurációs dokumentumban lévő erőforráspéldányok a kívánt állapotban vannak-e.

Syntax

Konfigurációs dokumentum az stdinből

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

Konfigurációs dokumentum a beállítási sztringből

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

Konfigurációs dokumentum fájlból

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

Description

Az test alparancs ellenőrzi, hogy a konfigurációs dokumentum erőforráspéldányai a kívánt állapotban vannak-e. A parancs futtatásakor a DSC ellenőrzi a konfigurációs dokumentumot, mielőtt a dokumentumban definiált egyes erőforráspéldányok tesztműveletét invokálná.

A konfigurációs dokumentumot JSON-ként vagy YAML-ként kell átadni ehhez a parancshoz stdinen keresztül, a dokumentumbeállítást tartalmazó sztringként vagy egy elérési utat tartalmazó fájlból.

Példák

1. példa – Annak tesztelése, hogy egy konfiguráció erőforráspéldányai a kívánt állapotban vannak-e

A parancs visszaadja az állapotot, a kívánt állapotot, a tényleges állapotot és a konfigurációs dokumentumban mentett example.dsc.config.yamlerőforráspéldányok eltérő tulajdonságait.

# 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

2. példa – Beolvasandó fájl átadása konfigurációs dokumentumként

A parancs az elérési út beállítással ellenőrzi a fájlban definiált konfigurációt example.dsc.config.yaml .

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

3. példa – Konfigurációs dokumentum átadása változóként

A parancs a dokumentumbeállítással ellenőrzi a változóban tárolt konfigurációt $desired .

dsc config test --document $desired

Beállítások

-d, --document

Megadja azt a konfigurációs dokumentumot, amelynél ellenőrizni szeretné az állapotot. A dokumentumnak egy JSON- vagy YAML-objektumot tartalmazó sztringnek kell lennie. A DSC ellenőrzi a dokumentumot a konfigurációs dokumentum sémájában. Ha az ellenőrzés sikertelen, a DSC hibát jelez.

Ez a beállítás nem használható az stdin vagy a --path beállítás feletti konfigurációs dokumentummal. Adja meg, hogy a konfigurációs dokumentumot át szeretné-e adni az stdin parancsnak, egy beállítással rendelkező --path fájlból vagy a --document beállítással.

Type:      String
Mandatory: false

-p, --path

Egy konfigurációs dokumentum elérési útját határozza meg, amely az állapot ellenőrzésére szolgál ahelyett, hogy a dokumentumot az stdinből pipálja, vagy sztringként adja át a --document beállítással. A megadott fájlnak tartalmaznia kell egy konfigurációs dokumentumot JSON- vagy YAML-objektumként. A DSC ellenőrzi a dokumentumot a konfigurációs dokumentum sémájában. Ha az ellenőrzés sikertelen, vagy ha a megadott fájl nem létezik, a DSC hibát jelez.

Ez a lehetőség kölcsönösen kizárja a --document lehetőséget. Ha ezt a beállítást használja, a DSC figyelmen kívül hagyja az stdin összes bemenetét.

Type:      String
Mandatory: false

-f, --format

A --format beállítás szabályozza a parancs konzolkimeneti formátumát. Ha a parancs kimenetét átirányítja vagy változóként rögzíti, a kimenet mindig JSON lesz.

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

-h, --help

Megjeleníti az aktuális parancs vagy alparancs súgóját. Ha ezt a beállítást adja meg, az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot ezt követően.

Type:      Boolean
Mandatory: false

Kimenet

Ez a parancs JSON-kimenetet ad vissza, amely tartalmazza, hogy a művelet vagy bármely erőforrás hibát jelzett-e, a művelet során kibocsátott üzenetek gyűjteményét, valamint a tesztművelet eredményeit minden példány esetében. További információt a dsc konfigurációs teszt eredménysémája című témakörben talál.