dsc

Synopsis

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

Syntax

dsc [Options] <COMMAND>

Commands

Завершитель

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

config

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

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

Для получения дополнительной информации см. конфигурацию DSC.

resource

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

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

Для получения дополнительной информации см. ресурс DSC

schema

schema Команда возвращает схему JSON для конкретного типа DSC. Для получения дополнительной информации см. схему DSC.

Справка

Команда возвращает help справочную информацию для DSC, команды или подкоманды.

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

dsc help <COMMAND> [<SUBCOMMAND>]

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

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

Параметры

-л, --на уровне следов

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

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

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

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

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

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

Type         : string
Mandatory    : false
DefaultValue : warn
ValidValues  : [error, warn, info, debug, trace]
LongSyntax   : --trace-level <TRACE_LEVEL>
ShortSyntax  : -l <TRACE_LEVEL>

-f, --trace-format

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

• default - Выпускает сообщение с ANSI-раскраской консоли для метки времени, уровня сообщения и номера строки.
• plaintext - Как default и без каких-либо цветов консоли.
• json - Каждое сообщение выпускает в виде сжатого JSON-объекта с свойствами временной метки, уровня, сообщения и номера строки.

Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --прогресс-формат

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

• default - Показывает индикатор прогресса, если DSC обнаруживает интерактивный вызов. В остальном DSC не показывает прогресса.
• none - Прогресса нет.
• json - Излучает прогресс в виде сжатых JSON-объектов с свойствами временной метки, уровня, сообщения и номера строки.

Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --версия

Отображается версия приложения. Когда вы задаёте эту опцию, приложение игнорирует все опции и аргументы, кроме --help, который отменяет эту опцию.

Type        : boolean
Mandatory   : false
LongSyntax  : --version
ShortSyntax : -V

-h, --помощь

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

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

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

По умолчанию 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 .

Примечания

DSC ожидает, что входные строки будут использовать кодирование UTF-8. Когда вы передаёте данные из stdin или пути в файл, убедитесь, что вход закодирован как UTF-8.