konfiguracja dsc

Streszczenie

Zastosuj dokument konfiguracji.

Składnia

dsc config [Options] <COMMAND>

Opis

Polecenie dsc config zawiera podpolecenia służące do zarządzania wystąpieniami zasobów zdefiniowanymi w dokumencie konfiguracyjnym DSC. Aby bezpośrednio zarządzać zasobami, zobacz polecenie dsc resource .

Komendy

eksportować

Polecenie export generuje dokument konfiguracji, który definiuje istniejące wystąpienia zestawu zasobów. Aby uzyskać więcej informacji, zobacz Eksport konfiguracji dsc.

pobranie

Polecenie get pobiera bieżący stan wystąpień zasobów w dokumencie konfiguracji. Aby uzyskać więcej informacji, zobacz dsc config get.

ustawić

Polecenie set wymusza żądany stan wystąpień zasobów w dokumencie konfiguracyjnym. Aby uzyskać więcej informacji, zobacz DSC config set (Zestaw konfiguracji dsc).

test

Polecenie test sprawdza, czy wystąpienia zasobów w dokumencie konfiguracji są w żądanym stanie. Aby uzyskać więcej informacji, zobacz DSC config test (Test konfiguracji dsc).

pomoc

Polecenie help zwraca informacje pomocy dla tego polecenia lub podpolecenia.

Aby uzyskać pomoc dotyczącą polecenia lub podpolecenia, użyj składni:

dsc config help [<SUBCOMMAND>]

Na przykład dsc config help pobiera pomoc dotyczącą tego polecenia. dsc config help set Pobiera pomoc dotyczącą set podpolecenia.

Możesz również użyć opcji --help w poleceniu lub podpoleceniu, aby wyświetlić informacje pomocy. Na przykład: dsc config --help lub dsc config set --help.

Opcje

-f, --plik-parametrów

Określa ścieżkę do pliku danych zawierającego parametry, które mają być przekazywane do konfiguracji w formacie JSON lub YAML. Po określeniu tej opcji konfiguracja DSC interpretuje klucze w pliku danych jako parametry i używa określonych wartości. Wartości w pliku danych zastępują wszelkie wartości domyślne zdefiniowane w samej konfiguracji.

Plik danych musi zawierać obiekt z kluczem parameters . Wartość klucza parameters musi być obiektem, w którym każdy klucz jest nazwą zdefiniowanego parametru, a każda wartość jest prawidłową wartością dla tego parametru.

Ta opcja wzajemnie się wyklucza z --parameters opcją.

Począwszy od DSC w wersji 3.1.0, można przekazać parametry danych do podpolecenia za pośrednictwem stdin. W takim przypadku należy przekazać dokument konfiguracyjny jako ciąg wejściowy lub ścieżkę do pliku w systemie. Nie można przekazać zarówno pliku parametrów, jak i dokumentu konfiguracji do polecenia ze standardowego wejścia.

Aby uzyskać więcej informacji na temat definiowania parametrów w dokumencie konfiguracji, zobacz Schemat parametrów dokumentu konfiguracji DSC. Aby uzyskać więcej informacji na temat używania parametrów w dokumencie konfiguracyjnym, zobacz dokumentację funkcji parameters.

Type        : string
Mandatory   : false
LongSyntax  : --parameters-file <PARAMETERS_FILE>
ShortSyntax : -f <PARAMETERS_FILE>

-p, --parametry

Określa parametry, które mają być przekazywane do dokumentu konfiguracyjnego jako ciąg danych sformatowany jako JSON lub YAML. Po określeniu tej opcji konfiguracja DSC interpretuje klucze w ciągu danych jako parametry i używa określonych wartości. Wartości w ciągu danych zastępują wszelkie wartości domyślne zdefiniowane w samym dokumencie konfiguracyjnym.

Ciąg danych musi zawierać obiekt z kluczem parameters . Wartość klucza parameters musi być obiektem, w którym każdy klucz jest nazwą zdefiniowanego parametru, a każda wartość jest prawidłową wartością dla tego parametru.

Ta opcja wzajemnie się wyklucza z --parameters_file opcją.

Aby uzyskać więcej informacji na temat definiowania parametrów w dokumencie konfiguracji, zobacz Schemat parametrów dokumentu konfiguracji DSC. Aby uzyskać więcej informacji na temat używania parametrów w dokumencie konfiguracyjnym, zobacz dokumentację funkcji parameters.

Type        : string
Mandatory   : false
LongSyntax  : --parameters <PARAMETERS>
ShortSyntax : -p <PARAMETERS>

-r, --główny-systemowy katalog główny

Użyj tej opcji, aby określić ścieżkę do katalogu głównego systemu operacyjnego, jeśli nie jesteś przeznaczony dla bieżącego uruchomionego systemu operacyjnego.

Type        : string
Mandatory   : false
LongSyntax  : --system-root <SYSTEM_ROOT>
ShortSyntax : -r <SYSTEM_ROOT>

-h, --help (pomoc)

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

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

Zmienne środowiskowe

Podpolecenia dsc config * tworzą zmienną środowiskową DSC_CONFIG_ROOT po wywołaniu polecenia z --path opcją określenia dokumentu konfiguracyjnego, który ma być używany dla polecenia. DSC ustawia wartość zmiennej środowiskowej DSC_CONFIG_ROOT na pełną ścieżkę folderu zawierającego określony dokument konfiguracji.

Uwaga / Notatka

Jeśli zdefiniujesz zmienną DSC_CONFIG_ROOT poza DSC, DSC zgłasza ostrzeżenie, gdy zastępuje wartość istniejącej zmiennej środowiskowej dla operacji.

Możesz użyć funkcji konfiguracji envvar , aby odwołać się do tej ścieżki folderu dla wystąpień zasobów w konfiguracji.