dsc

概要

应用配置或调用特定资源来管理软件组件。

Syntax

dsc [Options] <COMMAND>

指令

完备者

该 completer 命令返回一个 shell 脚本，执行后会为给定 shell 注册完成任务。 更多信息请参见 dsc completer。

config

该 config 命令管理DSC配置文档。 你可以用其执行以下操作：

  • 获取当前配置的状态。
  • 测试配置是否处于期望状态。
  • 将配置设置为目标状态。

更多信息请参见 dsc 配置。

资源

该 resource 指挥部管理一个DSC资源。 你可以用其执行以下操作：

  • 列出可用的资源。
  • 获取资源实例的JSON模式。
  • 获取资源实例的当前状态。
  • 测试资源实例是否处于期望状态。
  • 将资源实例设置为期望状态。

更多信息请参见 DSC资源

架构

该 schema 命令返回特定 DSC 类型的 JSON 模式。 更多信息请参见 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。

选项

-l， --微量级

定义了DSC在操作过程中应发出的最小消息级别。 DSC中的消息按级别分类。

以下列表显示了从最高到最低的有效消息级别。 当该选项设置为列表中任意值时，DSC会发送该级别及以上的消息。

  • error
  • warn（默认值）
  • info
  • debug
  • trace

Warning

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-格式

定义了在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， --progress-格式

定义了在 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 以外的所有选项和参数，而 --help 会覆盖该选项。

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

-h、--help

显示当前命令或子命令的帮助。 指定此选项时，应用程序将忽略所有其他选项和参数。

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

环境变量

默认情况下，命令 dsc 会在环境变量定义 PATH 的文件夹中搜索 DSC 资源显现。 如果 DSC_RESOURCE_PATH 定义了环境变量，则 dsc 会搜索 中的 DSC_RESOURCE_PATH 文件夹，而不是 PATH。

DSC_RESOURCE_PATH环境必须是一个环境变量，遵循与PATH操作系统环境变量相同的约定。 文件夹路径分开，Windows用分号（;），其他平台用冒号（:）。

退出代码

该 dsc 命令使用语义退出码。 每个出口代码代表命令执行的不同结果。

退出代码 Meaning
0 命令成功执行，没有任何错误。
1 命令失败是因为它收到了无效参数。
2 命令失败是因为某个资源触发了错误。
3 命令失败是因为某个值无法从JSON序列化或反序列化。
4 命令失败是因为输入的 YAML 或 JSON 都不有效。
5 该命令失败是因为某个资源定义或实例值在其 JSON 模式中无效。
6 该命令被 Ctrl+C 中断取消。

备注

DSC期望输入字符串使用UTF-8编码。 当你从标准输入或文件路径传递输入时，确保输入编码为 UTF-8。

  • Last updated on