Поделиться через

DSC

  • Статья

Краткий обзор

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

Синтаксис

dsc [Options] <COMMAND>

Команды

completer

Команда completer возвращает скрипт оболочки, который при выполнении регистрирует завершения для заданной оболочки. Дополнительные сведения см. в разделе Completer.

config

Команда config управляет документом конфигурации DSC. Ее можно использовать в следующих целях:

  • Получение текущего состояния конфигурации.
  • Проверьте, находится ли конфигурация в нужном состоянии.
  • Задайте для конфигурации требуемое состояние.

Дополнительные сведения см. в разделе config.

ресурс

Команда resource управляет ресурсом DSC. Ее можно использовать в следующих целях:

  • Список доступных ресурсов.
  • Получите схему JSON для экземпляров ресурса.
  • Получение текущего состояния экземпляра ресурса.
  • Проверьте, находится ли экземпляр ресурса в нужном состоянии.
  • Задайте для экземпляра ресурса требуемое состояние.

Дополнительные сведения см. в разделе resource

схема

Команда schema возвращает схему JSON для определенного типа DSC. Дополнительные сведения см. в разделе Схема.

help

Команда возвращает справочные help сведения для dsc, команды или подкоманды.

Чтобы получить справку по команде или подкоманде, используйте синтаксис:

dsc help <COMMAND> [<SUBCOMMAND>]

Например, dsc help config получает справку для config подкоманды. dsc help config set получает справку для config set подкоманды.

Вы также можете использовать параметр --help в команде для отображения сведений справки. Например, dsc config --help или dsc config set --help.

Варианты

-h, --help

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

Type:      Boolean
Mandatory: false

-l, --trace-level

Определяет минимальный уровень сообщений, который DSC должен выдавать во время операции. Сообщения в DSC классифицируются по уровню.

В следующем списке показаны допустимые уровни сообщений от самого высокого до самого низкого. Если для этого параметра задано любое значение в списке, DSC выдает сообщения на этом уровне и выше.

  • error
  • warning (по умолчанию)
  • info
  • debug
  • trace

Предупреждение

Выходные trace данные уровня выдают все входные и выходные данные JSON, которые DSC обрабатывает во время выполнения. DSC не очищает JSON перед его отправкой. Этот уровень трассировки предназначен только для использования разработчиками. Никогда не перенаправляйте trace выходные данные уровня в хранилище, так как оно может содержать конфиденциальную информацию.

Например, если уровень журнала равен debug, DSC выдает сообщения для каждого уровня журнала, кроме trace. Если уровень журнала равен error, DSC выдает только сообщения об ошибках. DSC игнорирует каждое сообщение с более низким уровнем журнала.

Type:         String
Mandatory:    false
DefaultValue: warning
ValidValues:  [error, warning, info, debug, trace]

-f, --trace-format

Определяет формат вывода, используемый при отправке сообщений трассировки в stderr. DSC поддерживает следующие форматы:

  • default — выдает сообщение с раскраской консоли ANSI для метки времени, уровня сообщения и номера строки.
  • plaintext — Как default , но без каких-либо цветов консоли.
  • json — выдает каждое сообщение в виде сжатого объекта JSON с меткой времени, уровнем, сообщением и номером строки в качестве свойств.
Type:         String
Mandatory:    false
DefaultValue: default
ValidValues:  [default, plaintext, json]

-V, --version

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

Type:      Boolean
Mandatory: false

Переменные среды

По умолчанию команда ищет манифесты ресурсов DSC на основе команд в папках, dsc определенных переменной PATH среды. Если переменная среды определена DSC_RESOURCE_PATH , dsc выполняет поиск в папках DSC_RESOURCE_PATH вместо PATH.

Среда DSC_RESOURCE_PATH должна быть переменной среды, которая соответствует тем же соглашениям, что и PATH переменная среды для операционной системы. Разделяйте пути к папкам точкой с запятой (;) в Windows и двоеточием (:) на других платформах.

Коды выхода

Команда dsc использует семантические коды выхода. Каждый код выхода представляет отдельный результат выполнения команды.

Код завершения Значение
0 Команда успешно выполнена без ошибок.
1 Команда завершилась сбоем, так как она получила недопустимые аргументы.
2 Команда завершилась сбоем, так как ресурс вызвал ошибку.
3 Не удалось выполнить команду, так как не удалось сериализовать значение в json или десериализовать из нее.
4 Команда завершилась сбоем, так как входные данные для команды не были допустимыми YAML или JSON.
5 Команда завершилась сбоем, так как определение ресурса или значение экземпляра было недопустимым для его схемы JSON.
6 Команда была отменена нажатием клавиши CTRL+C .