dsc

Sinopsis

Aplica la configuración o invoca recursos específicos para gestionar componentes de software.

Sintaxis

dsc [Options] <COMMAND>

Commands

Completador

El completer comando devuelve un script de shell que, al ejecutarse, registra completaciones para el shell dado. Para más información, consulta dsc completer.

config

El config comando gestiona un documento de configuración DSC. Puede usarlo para:

  • Obtén el estado actual de la configuración.
  • Comprobar si una configuración está en el estado deseado.
  • Establece una configuración en el estado deseado.

Para más información, consulta dsc config.

resource

El resource mando gestiona un recurso DSC. Puede usarlo para:

  • Enumera los recursos disponibles.
  • Consigue el esquema JSON de las instancias de un recurso.
  • Obtén el estado actual de una instancia de recurso.
  • Comprobar si una instancia de recurso está en el estado deseado.
  • Establece una instancia de recurso en el estado deseado.

Para más información, consulte el recurso dsc

schema

El schema comando devuelve el esquema JSON para un tipo específico de DSC. Para más información, consulta esquema dsc.

Ayuda

El help comando devuelve información de ayuda para dsc, un comando o un subcomando.

Para obtener ayuda para un comando o subcomando, utiliza la sintaxis:

dsc help <COMMAND> [<SUBCOMMAND>]

Por ejemplo, dsc help config recibe ayuda para el config subcomando. dsc help config set Recibe ayuda para el config set subcomando.

También puedes usar la opción --help en un comando para mostrar la información de ayuda. Por ejemplo, dsc config --help o dsc config set --help.

Opciones

-l, --nivel de traza

Define el nivel mínimo de mensaje que el DSC debe emitir durante una operación. Los mensajes en DSC se categorizan según su nivel.

La siguiente lista muestra los niveles de mensaje válidos desde el nivel más alto hasta el más bajo. Cuando esta opción se establece en cualquier valor en la lista, DSC emite mensajes a ese nivel y superiores.

  • error
  • warn (valor predeterminado)
  • info
  • debug
  • trace

Warning

La salida de nivel trace emite toda la entrada/salida JSON que procesa el DSC durante la ejecución. DSC no desinfecta el JSON antes de emitirlo. Este nivel de traza está destinado únicamente al uso de los desarrolladores. Nunca redirijas trace la salida a nivel de almacenamiento porque podría contener información sensible.

Por ejemplo, cuando el nivel logarítmico es debug, DSC emite mensajes para cada nivel logarítmic excepto trace. Cuando el nivel de registro es error, DSC solo emite mensajes de error. DSC ignora todos los mensajes con un nivel logarítmico inferior.

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

-f, --formato de traza

Define el formato de salida a usar al emitir mensajes de traza en stderr. DSC soporta los siguientes formatos:

  • default - Emite el mensaje con coloración ANSI de la consola para la marca de tiempo, nivel de mensaje y número de línea.
  • plaintext - Pero default sin colores de consola.
  • json - Emite cada mensaje como un objeto JSON comprimido con la marca de tiempo, nivel, mensaje y número de línea como propiedades.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --progreso-formato

Define el formato de progreso a usar al emitir mensajes de progreso en stderr. DSC soporta los siguientes formatos:

  • default - Muestra una barra de progreso si DSC detecta que se está llamando de forma interactiva. Por lo demás, DSC no muestra ningún progreso.
  • none - No muestra ningún avance.
  • json - Emite progreso como objetos JSON comprimidos con la marca de tiempo, nivel, mensaje y número de línea como propiedades.
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V, --versión

Muestra la versión de la aplicación. Cuando especificas esta opción, la aplicación ignora todas las opciones y argumentos excepto --help, que anula esta opción.

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

-h, --ayuda

Muestra la ayuda para el comando o subcomando actual. Cuando se especifica esta opción, la aplicación ignora todas las demás opciones y argumentos.

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

Variables de entorno

Por defecto, el dsc comando busca los manifiestos de recursos DSC en las carpetas definidas por la PATH variable de entorno. Si la DSC_RESOURCE_PATH variable de entorno está definida, dsc busca en las carpetas en DSC_RESOURCE_PATH lugar de PATH.

El DSC_RESOURCE_PATH entorno debe ser una variable de entorno que siga las mismas convenciones que la PATH variable de entorno del sistema operativo. Rutas de carpetas separadas con punto y coma (;) en Windows y dos puntos (:) en otras plataformas.

Códigos de salida

El dsc comando utiliza códigos semánticos de salida. Cada código de salida representa un resultado diferente para la ejecución del comando.

Código de salida Meaning
0 El comando se ejecutó con éxito y sin errores.
1 El comando falló porque recibió argumentos inválidos.
2 El comando falló porque un recurso generó un error.
3 El comando falló porque un valor no podía ser serializado ni deserializado desde JSON.
4 El comando falló porque la entrada para el comando no era válida ni en YAML ni en JSON.
5 El comando falló porque una definición de recurso o valor de instancia era inválido contra su esquema JSON.
6 El comando fue cancelado por una interrupción Ctrl+C .

Notas

DSC espera que las cadenas de entrada usen codificación UTF-8. Cuando pases la entrada de stdin o la ruta a un archivo, asegúrate de que la entrada esté codificada como UTF-8.