Test konfigurace dsc

Článek
06/24/2024

Synopse

Ověří, jestli jsou instance prostředků v konfiguračním dokumentu v požadovaném stavu.

Syntax

Dokument o konfiguraci ze stdin

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

Konfigurační dokument z řetězce možností

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

Konfigurační dokument ze souboru

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

Description

Podpříkaz test ověřuje, jestli jsou instance prostředků v konfiguračním dokumentu v požadovaném stavu. Po spuštění tohoto příkazu nástroj DSC před vyvoláním testovací operace pro každou instanci prostředku definovanou v dokumentu ověří dokument konfigurace.

Konfigurační dokument musí být tomuto příkazu předán jako JSON nebo YAML přes stdin, jako řetězec s možností dokumentu nebo ze souboru s možností path .

Příklady

Příklad 1 – Test, jestli jsou instance prostředků konfigurace v požadovaném stavu

Příkaz vrátí stav, požadovaný stav, skutečný stav a různé vlastnosti pro instance prostředků definované v konfiguračním dokumentu uloženém jako 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

Příklad 2 – Předání souboru, který se má číst jako konfigurační dokument

Příkaz použije možnost cesty k ověření konfigurace definované v example.dsc.config.yaml souboru.

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

Příklad 3 – Předání konfiguračního dokumentu jako proměnné

Příkaz použije možnost dokumentu k ověření konfigurace uložené v $desired proměnné.

dsc config test --document $desired

Možnosti

-d, --document

Určuje dokument konfigurace, pro který se má ověřit stav. Dokument musí být řetězec obsahující objekt JSON nebo YAML. DSC ověří dokument proti schématu konfiguračního dokumentu. Pokud se ověření nezdaří, DSC vyvolá chybu.

Tuto možnost nelze použít s konfiguračním dokumentem nad stdin nebo --path možností. Zvolte, jestli chcete předat konfigurační dokument příkazu přes stdin, ze souboru s --path možností nebo s --document možností .

Type:      String
Mandatory: false

-p, --path

Definuje cestu ke konfiguračnímu dokumentu pro ověření stavu místo propojení dokumentu ze stdin nebo jeho předání jako řetězce s --document možností . Zadaný soubor musí obsahovat konfigurační dokument jako objekt JSON nebo YAML. DSC ověří dokument proti schématu konfiguračního dokumentu. Pokud se ověření nezdaří nebo pokud zadaný soubor neexistuje, DSC vyvolá chybu.

Tato možnost se s možností vzájemně vylučuje --document . Když použijete tuto možnost, DSC ignoruje všechny vstupy ze stdin.

Type:      String
Mandatory: false

-f, --format

Možnost --format řídí formát výstupu konzoly pro příkaz. Pokud je výstup příkazu přesměrovaný nebo zachycený jako proměnná, je výstup vždy JSON.

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

-h, --help

Zobrazí nápovědu k aktuálnímu příkazu nebo dílčímu příkazu. Když zadáte tuto možnost, aplikace ignoruje všechny možnosti a argumenty za touto možností.

Type:      Boolean
Mandatory: false

Výstup

Tento příkaz vrátí výstup JSON, který zahrnuje, jestli operace nebo jakékoli prostředky vyvolaly nějaké chyby, kolekci zpráv vysílaných během operace a výsledky testovací operace pro každou instanci. Další informace najdete v tématu schéma výsledků testu konfigurace dsc.

Sdílet prostřednictvím