dsc-configuratieset

Samenvatting

Dwingt de gewenste status van resource-exemplaren af in een configuratiedocument.

Syntaxis

Configuratiedocument uit bestand

dsc config set [Options] --file <FILE>

Configuratiedocument uit optietekenreeks

dsc config set [Options] --input <INPUT>

Configuratiedocument van stdin

cat <FILE> | dsc config set [Options] --file -

Configuratiedocument uit bestand met parameters uit stdin

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

Configuratiedocument van optiereeks met parameters van stdin

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

Beschrijving

Het set subcommando dwingt de gewenste status van de resource-exemplaren af in een configuratiedocument. Wanneer deze opdracht wordt uitgevoerd, valideert DSC het configuratiedocument voordat de testbewerking wordt aanroepen voor elk resource-exemplaar dat in het document is gedefinieerd. DSC roept vervolgens de setbewerking aan voor elk resource-exemplaar dat niet de gewenste status heeft.

Het configuratiedocument moet aan deze opdracht worden doorgegeven als JSON of YAML met de --input optie of --file .

Voorbeelden

Voorbeeld 1: de resource-exemplaren van een configuratie instellen op de gewenste status

De opdracht inspecteert de resource-exemplaren die zijn gedefinieerd in het configuratiedocument dat is opgeslagen als example.dsc.config.yaml en stelt ze indien nodig in op de gewenste status.

# example.dsc.config.yaml
$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
resources:
- name: Windows only
  type: Microsoft.DSC/Assertion
  properties:
    $schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
    resources:
    - name: os
      type: Microsoft/OSInfo
      properties:
        family: Windows
- name: Current user registry example
  type: Microsoft.Windows/Registry
  properties:
    keyPath: HKCU\example
    _exist: true
  dependsOn:
    - "[resourceId('Microsoft.DSC/Assertion', 'Windows only')"

cat ./example.dsc.config.yaml | dsc config set --file -

Voorbeeld 2: een bestand doorgeven dat moet worden gelezen als het configuratiedocument

De opdracht gebruikt de bestandsoptie om de configuratie af te dwingen die in het example.dsc.config.yaml bestand is gedefinieerd.

dsc config set --file ./example.dsc.config.yaml

Voorbeeld 3: een configuratiedocument doorgeven als een variabele

De opdracht gebruikt de invoeroptie om de configuratie af te dwingen die in de $desired variabele is opgeslagen.

dsc config set --input $desired

Opties

-i, --invoer

Hiermee geeft u het configuratiedocument om de status af te dwingen voor.

Het document moet een tekenreeks zijn die een JSON- of YAML-object bevat. DSC valideert het document op basis van het configuratiedocumentschema. Als de validatie mislukt, genereert DSC een fout.

Deze optie sluit elkaar uit met de --file optie.

Type        : string
Mandatory   : false
LongSyntax  : --input <INPUT>
ShortSyntax : -i <INPUT>

-f, --bestand

Definieert het pad naar een configuratiedocument waarvoor de status moet worden afgedwongen.

Het opgegeven bestand moet een configuratiedocument bevatten als een JSON- of YAML-object. DSC valideert het document op basis van het configuratiedocumentschema. Als de validatie mislukt of als het opgegeven bestand niet bestaat, genereert DSC een fout.

U kunt deze optie ook gebruiken om een configuratiedocument van stdin door te geven, zoals wordt weergegeven in voorbeeld 1.

Deze optie sluit elkaar uit met de --input optie.

Type        : string
Mandatory   : false
LongSyntax  : --file <FILE>
ShortSyntax : -f <FILE>

-w, --wat-als

Wanneer u deze vlagoptie opgeeft, wordt de systeemstatus van DSC niet gewijzigd met de set bewerking. In plaats daarvan retourneert het uitvoer die aangeeft hoe de bewerking de systeemstatus zal wijzigen wanneer deze zonder deze optie wordt aangeroepen. Gebruik deze optie om een voorbeeld te bekijken van de wijzigingen die DSC in een systeem aanbrengt.

De uitvoer voor de opdracht wanneer u deze optie gebruikt, is hetzelfde als zonder, behalve dat het ExecutionType metagegevensveld is ingesteld op WhatIf in plaats van Actual.

Type        : boolean
Mandatory   : false
LongSyntax  : --what-if
ShortSyntax : -w

-o, --uitvoer-formaat

De --output-format optie bepaalt welke indeling DSC gebruikt voor de gegevens die de opdracht retourneert. De beschikbare formaten zijn:

• json om de gegevens als een JSON-lijn uit te zenden.
• pretty-json om de gegevens uit te zenden als JSON met nieuwe regels, inspringing en spaties voor leesbaarheid.
• yaml om de gegevens als YAML uit te zenden.

De standaarduitvoerindeling is afhankelijk van het feit of DSC detecteert dat de uitvoer wordt omgeleid of als een variabele wordt vastgelegd:

• Als de opdracht niet wordt omgeleid of vastgelegd, geeft DSC de uitvoer weer als de yaml indeling in de console.
• Als de opdrachtuitvoer wordt omgeleid of vastgelegd, verzendt DSC de gegevens als het json formaat om te stdout.

Wanneer u deze optie gebruikt, gebruikt DSC de opgegeven indeling, ongeacht of de opdracht wordt omgeleid of vastgelegd.

Wanneer de opdracht niet wordt omgeleid of vastgelegd, wordt de uitvoer in de console geformatteerd voor een betere leesbaarheid. Wanneer de opdracht niet wordt omgeleid of vastgelegd, bevat de uitvoer terminalsequenties voor opmaak.

Type        : string
Mandatory   : false
ValidValues : [json, pretty-json, yaml]
LongSyntax  : --output-format <OUTPUT_FORMAT>
ShortSyntax : -o <OUTPUT_FORMAT>

-h, --hulp

Geeft de Help weer voor de huidige opdracht of subopdracht. Wanneer u deze optie opgeeft, worden alle andere opties en argumenten genegeerd.

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

Uitvoer

Deze opdracht retourneert geformatteerde gegevens, waaronder of de bewerking of resources fouten hebben veroorzaakt, het verzamelen van berichten die tijdens de bewerking zijn verzonden en de ingestelde bewerkingsresultaten voor elk exemplaar. Zie voor meer informatie dsc config get result schema.

Zie de optie --output-format voor meer informatie over de opmaak van de uitvoergegevens.