zestaw konfiguracji dsc

Artykuł
06/25/2024

Streszczenie

Wymusza żądany stan wystąpień zasobów w dokumencie konfiguracji.

Składnia

Dokument konfiguracji ze stdin

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

Dokument konfiguracji z ciągu opcji

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

Dokument konfiguracji z pliku

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

Opis

Podpolecenia set wymusza żądany stan wystąpień zasobów w dokumencie konfiguracji. Po uruchomieniu tego polecenia rozszerzenie DSC weryfikuje dokument konfiguracji przed wywołaniem operacji testowania dla każdego wystąpienia zasobu zdefiniowanego w dokumencie. DsC następnie wywołuje operację zestawu dla każdego wystąpienia zasobu, które nie jest w żądanym stanie.

Dokument konfiguracji musi zostać przekazany do tego polecenia jako plik JSON lub YAML za pomocą narzędzia stdin, jako ciąg z opcją dokumentu lub z pliku z opcją ścieżki .

Przykłady

Przykład 1 — ustawianie wystąpień zasobów konfiguracji na żądany stan

Polecenie sprawdza wystąpienia zasobów zdefiniowane w dokumencie konfiguracji zapisanym jako example.dsc.config.yaml i ustawia je na żądany stan zgodnie z potrzebami.

# 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

Przykład 2 — przekazywanie pliku do odczytu jako dokumentu konfiguracji

Polecenie używa opcji ścieżki , aby wymusić konfigurację zdefiniowaną w pliku .

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

Przykład 3 — przekazywanie dokumentu konfiguracji jako zmiennej

Polecenie używa opcji dokumentu , aby wymusić konfigurację przechowywaną w zmiennej .

dsc config set --document $desired

Opcje

-d, --document

Określa dokument konfiguracji, aby wymusić stan dla. Dokument musi być ciągiem zawierającym obiekt JSON lub YAML. Rozszerzenie DSC weryfikuje dokument względem schematu dokumentu konfiguracji. Jeśli walidacja zakończy się niepowodzeniem, rozszerzenie DSC zgłosi błąd.

Tej opcji nie można używać z dokumentem konfiguracji za pośrednictwem narzędzia stdin lub opcji --path. Wybierz, czy należy przekazać dokument konfiguracji do polecenia za pośrednictwem narzędzia stdin, z pliku z opcją --path, czy z opcją --document.

Type:      String
Mandatory: false

-p, --path

Definiuje ścieżkę do dokumentu konfiguracji w celu wymuszenia stanu zamiast potokowania dokumentu ze stdin lub przekazywania go jako ciągu z opcją --document. Określony plik musi zawierać dokument konfiguracji jako obiekt JSON lub YAML. Rozszerzenie DSC weryfikuje dokument względem schematu dokumentu konfiguracji. Jeśli walidacja zakończy się niepowodzeniem lub jeśli określony plik nie istnieje, rozszerzenie DSC zgłasza błąd.

Ta opcja wyklucza się wzajemnie z opcją --document. Jeśli używasz tej opcji, DSC ignoruje wszelkie dane wejściowe ze stdin.

Type:      String
Mandatory: false

-w, --what-if

Po określeniu tej opcji flagi rozszerzenie DSC nie zmienia stanu systemu przy użyciu operacji set. Zamiast tego zwraca dane wyjściowe wskazujące , w jaki sposób operacja zmieni stan systemu po wywołaniu bez tej opcji. Użyj tej opcji, aby wyświetlić podgląd zmian DSC w systemie.

Dane wyjściowe polecenia, gdy używasz tej opcji, są takie same jak bez, z wyjątkiem tego, że pole metadanych ExecutionType jest ustawione na WhatIf zamiast Actual.

Type:      Boolean
Mandatory: false

-f, --format

Opcja --format steruje formatem danych wyjściowych konsoli dla polecenia . Jeśli dane wyjściowe polecenia są przekierowywane lub przechwytywane jako zmienna, dane wyjściowe są zawsze danymi JSON.

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

-h, --help

Wyświetla pomoc dla bieżącego polecenia lub podpolecenia. Po określeniu tej opcji aplikacja ignoruje wszystkie opcje i argumenty po tej opcji.

Type:      Boolean
Mandatory: false

Wyjście

To polecenie zwraca dane wyjściowe JSON, które zawierają informacje o tym, czy operacja lub jakiekolwiek zasoby zgłosiły jakiekolwiek błędy, kolekcja komunikatów emitowanych podczas operacji oraz wyniki operacji ustawiania dla każdego wystąpienia. Aby uzyskać więcej informacji, zobacz konfiguracji dsc get result schema.

Udostępnij za pośrednictwem