Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions dsc/docs-conceptual/dsc-3.0/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ in this release, see the [diff on GitHub][compare-v3.1.0].
- Added support for extensions to DSC. You can now use the `dsc extension list` command to
enumerate available extensions. DSC now supports a single extension capability, `discover`, which
returns JSON objects indicating where to find DSC resource manifests that aren't in the `PATH` or
`DSC_PATH`, as with resources installed as Appx packages.
`DSC_RESOURCE_PATH`, as with resources installed as Appx packages.

Now when DSC performs discovery, it recursively discovers extensions and resources on the system.

Expand Down Expand Up @@ -586,11 +586,11 @@ Version `3.0.0` is the first generally available release of DSC.
[release-v3.0.0]: https://github.com/PowerShell/DSC/releases/tag/v3.0.0 "Link to the DSC v3.0.0 release on GitHub"

<!-- Reference doc links -->
[cli.option.p]: ./reference/cli/index.md#--progress-format
[cli.resource.export]: ./reference/cli/resource/export.md
[schema.config.resource]: ./reference/schemas/config/resource.md
[schema.definitions.resourceKind]: ./reference/schemas/definitions/resourcekind.md
[schema.metadata]: ./reference/schemas/metadata/Microsoft.DSC/properties.md
[cli.option.p]: /powershell/dsc/reference/cli/?view=dsc-3.0&preserve-view=true#--progress-format
[cli.resource.export]: /powershell/dsc/reference/cli/resource/export?view=dsc-3.0&preserve-view=true
[schema.config.resource]: /powershell/dsc/reference/schemas/config/resource?view=dsc-3.0&preserve-view=true
[schema.definitions.resourceKind]: /powershell/dsc/reference/schemas/definitions/resourcekind?view=dsc-3.0&preserve-view=true
[schema.metadata]: /powershell/dsc/reference/schemas/metadata/microsoft.dsc/properties?view=dsc-3.0&preserve-view=true

<!-- Issue and PR links -->
[#328]: https://github.com/PowerShell/DSC/issues/328
Expand Down
14 changes: 13 additions & 1 deletion dsc/docs-conceptual/dsc-3.0/reference/cli/config/export.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config export' command
ms.date: 03/25/2025
ms.date: 07/03/2025
ms.topic: reference
title: dsc config export
---
Expand Down Expand Up @@ -31,6 +31,18 @@ dsc config export [Options] --input <INPUT>
cat <FILE> | dsc config export [Options] --file -
```

### Configuration document from file with parameters from stdin

```sh
cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --file <FILE>
```

### Configuration document from option string with parameters from stdin

```sh
cat <PARAMETERS_FILE> | dsc config --parameters-file - export [Options] --input <INPUT>
```

## Description

The `export` subcommand generates a configuration document that includes every instance of a set of
Expand Down
14 changes: 13 additions & 1 deletion dsc/docs-conceptual/dsc-3.0/reference/cli/config/get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config get' command
ms.date: 03/25/2025
ms.date: 07/03/2025
ms.topic: reference
title: dsc config get
---
Expand Down Expand Up @@ -31,6 +31,18 @@ dsc config get [Options] --input <INPUT>
cat <FILE> | dsc config get [Options] --file -
```

### Configuration document from file with parameters from stdin

```sh
cat <PARAMETERS_FILE> | dsc config --parameters-file - get [Options] --file <FILE>
```

### Configuration document from option string with parameters from stdin

```sh
cat <PARAMETERS_FILE> | dsc config --parameters-file - get [Options] --input <INPUT>
```

## Description

The `get` subcommand returns the actual state of the resource instances in a configuration
Expand Down
7 changes: 6 additions & 1 deletion dsc/docs-conceptual/dsc-3.0/reference/cli/config/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config' command
ms.date: 03/25/2025
ms.date: 07/03/2025
ms.topic: reference
title: dsc config
---
Expand Down Expand Up @@ -78,6 +78,11 @@ for that parameter.

This option is mutually exclusive with the `--parameters` option.

Starting with DSC version 3.1.0, you can pass the parameters data to a subcommand over stdin. When
you do, you must pass the configuration document as an input string or the path to a file on the
system. You can't pass both the parameters file and the configuration document to a command from
stdin.

For more information about defining parameters in a configuration document, see
[DSC Configuration document parameter schema][06]. For more information about using parameters in
configuration document, see the [parameters function reference][07].
Expand Down
23 changes: 18 additions & 5 deletions dsc/docs-conceptual/dsc-3.0/reference/cli/config/set.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config set' command
ms.date: 03/25/2025
ms.date: 07/03/2025
ms.topic: reference
title: dsc config set
---
Expand Down Expand Up @@ -31,6 +31,19 @@ dsc config set [Options] --input <INPUT>
cat <FILE> | dsc config set [Options] --file -
```

### Configuration document from file with parameters from stdin

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

### Configuration document from option string with parameters from stdin

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


## Description

The `set` subcommand enforces the desired state of the resource instances in a configuration
Expand Down Expand Up @@ -80,22 +93,22 @@ cat ./example.dsc.config.yaml | dsc config set --file -

<a id="example-2"></a>

The command uses the **path** option to enforce the configuration defined in the
The command uses the **file** option to enforce the configuration defined in the
`example.dsc.config.yaml` file.

```sh
dsc config set --path ./example.dsc.config.yaml
dsc config set --file ./example.dsc.config.yaml
```

### Example 3 - Passing a configuration document as a variable

<a id="example-3"></a>

The command uses the **document** option to enforce the configuration stored in the `$desired`
The command uses the **input** option to enforce the configuration stored in the `$desired`
variable.

```sh
dsc config set --document $desired
dsc config set --input $desired
```

## Options
Expand Down
16 changes: 14 additions & 2 deletions dsc/docs-conceptual/dsc-3.0/reference/cli/config/test.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Command line reference for the 'dsc config test' command
ms.date: 03/25/2025
ms.date: 07/03/2025
ms.topic: reference
title: dsc config test
---
Expand All @@ -22,7 +22,7 @@ dsc config test [Options] --file <FILE>
### Configuration document from option string

```sh
dsc config test [Options] --document <INPUT>
dsc config test [Options] --input <INPUT>
```

### Configuration document from stdin
Expand All @@ -31,6 +31,18 @@ dsc config test [Options] --document <INPUT>
cat <FILE> | dsc config test [Options] --file -
```

### Configuration document from file with parameters from stdin

```sh
cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --file <FILE>
```

### Configuration document from option string with parameters from stdin

```sh
cat <PARAMETERS_FILE> | dsc config --parameters-file - test [Options] --input <INPUT>
```

## Description

The `test` subcommand verifies whether the resource instances in a configuration document are in
Expand Down
64 changes: 64 additions & 0 deletions dsc/docs-conceptual/dsc-3.0/reference/cli/extension/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
description: Command line reference for the 'dsc extension' command
ms.date: 03/25/2025
ms.topic: reference
title: dsc extension
---

# dsc extension

## Synopsis

Operations on DSC extensions.

## Syntax

```sh
dsc extension [Options] <COMMAND>
```

## Description

The `dsc extension` command contains a subcommand for listing DSC extensions.

## Commands

### list

The `list` command returns the list of available DSC extensions with an optional filter. For more
information, see [dsc extension list][01].

### help

The `help` command returns help information for this command or a subcommand.

To get the help for a command or subcommand, use the syntax:

```sh
dsc extension help [<SUBCOMMAND>]
```

For example, `dsc extension help` gets the help for this command. `dsc extension help list`
gets the help for the `list` subcommand.

You can also use the [--help](#--help) option on the command or subcommand to display the help
information. For example, `dsc extension --help` or `dsc extension list --help`.

## Options

### -h, --help

<a id="-h"></a>
<a id="--help"></a>

Displays the help for the current command or subcommand. When you specify this option, the
application ignores all other options and arguments.

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

[01]: ./list.md
Loading
Loading