Набор конфигураций dsc

Синопсис

Применяет требуемое состояние экземпляров ресурсов в документе конфигурации.

Синтаксис

Документ конфигурации из файла

dsc config set [Options] --file <FILE>

Документ конфигурации из строки параметра

dsc config set [Options] --input <INPUT>

Документ конфигурации из stdin

cat <FILE> | dsc config set [Options] --file -

Конфигурационный документ из файла с параметрами из stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --file <FILE>

Конфигурационный документ из строки опций с параметрами из stdin

cat <PARAMETERS_FILE> | dsc config --parameters-file - set [Options] --input <INPUT>

Описание

Подкоманда set обеспечивает требуемое состояние экземпляров ресурсов в документе конфигурации. При выполнении этой команды DSC проверяет документ конфигурации перед вызовом тестовой операции для каждого экземпляра ресурса, определенного в документе. Затем DSC вызывает операцию набора для каждого экземпляра ресурса, который не имеет требуемого состояния.

Документ конфигурации должен быть передан этой команде в формате JSON или YAML с опцией or --input--file .

Примеры

Пример 1. Установка экземпляров ресурсов конфигурации в требуемое состояние

Команда проверяет экземпляры ресурсов, определенные в сохраненном как example.dsc.config.yaml конфигурационном документе, и при необходимости переводит их в нужное состояние.

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/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 --file -

Пример 2. Передача файла для чтения в качестве документа конфигурации

Команда использует параметр file для принудительного применения конфигурации, определенной в файле example.dsc.config.yaml .

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

Пример 3. Передача документа конфигурации в качестве переменной

Команда использует параметр input для принудительного применения конфигурации, хранящейся $desired в переменной.

dsc config set --input $desired

Параметры

-i, --input

Указывает документ конфигурации для принудительного применения состояния.

Документ должен быть строкой, содержащей объект JSON или YAML. DSC проверяет документ по схеме документа конфигурации. Если проверка завершается ошибкой, DSC вызывает ошибку.

Этот вариант является взаимоисключающим с вариантом --file .

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --файл

Определяет путь к конфигурационному документу, для которого необходимо применить состояние.

Указанный файл должен содержать документ конфигурации в виде объекта JSON или YAML. DSC проверяет документ по схеме документа конфигурации. Если проверка завершается ошибкой или если указанный файл не существует, DSC вызывает ошибку.

Вы также можете использовать эту опцию для передачи конфигурационного документа из стандартного ввода, как показано в примере 1.

Этот вариант является взаимоисключающим с вариантом --input .

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

-w, --что, если

Когда вы указываете этот параметр флага, DSC фактически не изменяет состояние системы вместе с set операцией. Вместо этого он возвращает выходные данные, указывающие, как операция изменит состояние системы при вызове без этой опции. Используйте этот параметр для предварительного просмотра изменений DSC, внесенных в систему.

Вывод команды при использовании этого параметра такой же, как и при его использовании, за исключением того, что ExecutionType поле метаданных устанавливается в значение WhatIf вместо Actual.

Type        : boolean
Mandatory   : false
LongSyntax  : --what-if
ShortSyntax : -w

-o, --output-format

Эта --output-format опция определяет, какой формат DSC использует для данных, возвращаемых командой. Доступные форматы:

  • json , чтобы выдать данные в виде строки JSON.
  • pretty-json , чтобы выдать данные в формате JSON с переводом строк, отступами и пробелами для удобочитаемости.
  • yaml , чтобы выдавать данные в формате YAML.

Формат вывода по умолчанию зависит от того, обнаруживает ли DSC, что вывод перенаправляется или записывается как переменная:

  • Если команда не перенаправляется или не записывается, DSC отображает выходные данные в виде формата yaml в консоли.
  • Если вывод команды перенаправляется или записывается, DSC выдает данные в json формате stdout.

При использовании этого параметра DSC использует указанный формат независимо от того, перенаправляется ли команда или захватывается.

Если команда не перенаправляется или не записывается, выходные данные в консоли форматируются для улучшения читаемости. Если команда не перенаправляется или не записывается, выходные данные включают последовательности терминалов для форматирования.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --помощь

Отображает справку для текущей команды или подкоманда. При указании этого параметра приложение игнорирует все остальные параметры и аргументы.

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

Выпуск

Эта команда возвращает отформатированные данные, которые включают в себя информацию о том, вызвали ли операция или какие-либо ресурсы какие-либо ошибки, коллекцию сообщений, отправленных во время операции, и заданные результаты операции для каждого экземпляра. Дополнительные сведения см. в разделе Схема получения результатов dsc config.

Для получения дополнительной информации о форматировании выходных данных см. опцию --output-format.

  • Last updated on