dsc konfigurációs csoport

Áttekintés

Kikényszeríti az erőforráspéldányok kívánt állapotát egy konfigurációs dokumentumban.

Szintaxis

Konfigurációs dokumentum az stdinből

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

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

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

Konfigurációs dokumentum fájlból

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

Leírás

A set alparancs kikényszeríti az erőforráspéldányok kívánt állapotát egy konfigurációs dokumentumban. 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 invesztálná. A DSC ezután meghívja a beállított műveletet minden olyan erőforráspéldányhoz, amely nem a kívánt állapotban van.

A konfigurációs dokumentumot JSON vagy YAML formátumban kell átadni a parancsnak stdinen keresztül, sztringként a dokumentum beállítással, vagy egy elérési út beállítással rendelkező fájlból.

Példák

1. példa – Konfiguráció erőforráspéldányainak beállítása a kívánt állapotra

A parancs a konfigurációs dokumentumban example.dsc.config.yaml mentett erőforráspéldányokat vizsgálja meg, és szükség szerint a kívánt állapotba állítja őket.

# 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

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

A parancs a elérési út beállítással kényszeríti ki a example.dsc.config.yaml fájlban definiált konfigurációt.

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

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

A parancs a dokumentum beállításával kényszeríti ki a $desired változóban tárolt konfigurációt.

dsc config set --document $desired

Beállítások

-d, --document

Megadja az állapot kényszerítéséhez szükséges konfigurációs dokumentumot. A dokumentumnak JSON- vagy YAML-objektumot tartalmazó sztringnek kell lennie. A DSC ellenőrzi a dokumentumot a konfigurációs dokumentum sémája alapján. Ha az ellenőrzés sikertelen, a DSC hibát jelez.

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

Type:      String
Mandatory: false

-p, --path

Meghatározza a konfigurációs dokumentum elérési útját, amely az állapot kényszerítéséhez szükséges ahelyett, hogy a dokumentumot az stdinből pipázza, vagy sztringként adja át a --document beállítással. A megadott fájlnak JSON- vagy YAML-objektumként kell tartalmaznia egy konfigurációs dokumentumot. A DSC ellenőrzi a dokumentumot a konfigurációs dokumentum sémája alapján. 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 bármely bemenetét.

Type:      String
Mandatory: false

-w, --what-if

Ha megadja ezt a jelzőbeállítást, a DSC valójában nem módosítja a rendszerállapotot a set művelettel. Ehelyett kimenetet ad vissza, amely azt jelzi, , hogy a művelet hogyan változtatja meg a rendszerállapotot, ha ez a beállítás nélkül van meghívva. Ezzel a beállítással megtekintheti a DSC rendszerbeli módosításainak előnézetét.

A parancs kimenete a beállítás használatakor ugyanaz, mint a nélkül, kivéve, hogy a ExecutionType metaadatmező WhatIf van beállítva Actualhelyett.

Type:      Boolean
Mandatory: false

-f, --format

A --format beállítás szabályozza a parancs konzolkimeneti formátumát. Ha a parancs kimenete átirányítva vagy változóként rögzítve van, 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. A beállítás megadásakor az alkalmazás figyelmen kívül hagyja az összes beállítást és argumentumot.

Type:      Boolean
Mandatory: false

Hozam

Ez a parancs JSON-kimenetet ad vissza, amely magában foglalja, 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, és a beállított művelet minden példányra vonatkozóan eredményt ad. További információ: dsc config get result schema.