DSC voor Linux nxEnvironment ResourceDSC for Linux nxEnvironment Resource

De nxEnvironment in PowerShell Desired State Configuration (DSC)-bron biedt een mechanisme op voor het beheren van omgevingsvariabelen op een Linux-knooppunt.The nxEnvironment resource in PowerShell Desired State Configuration (DSC) provides a mechanism to to manage system environment variables on a Linux node.

SyntaxisSyntax

nxEnvironment <string> #ResourceName
{
    Name = <string>
    [ Value = <string>
    [ Ensure = <string> { Absent | Present }  ]
    [ Path = <bool> }
    [ DependsOn = <string[]> ]

}

EigenschappenProperties

EigenschapProperty BeschrijvingDescription
NaamName Geeft de naam van de omgevingsvariabele waarvoor u wilt om te controleren of een specifieke status.Indicates the name of the environment variable for which you want to ensure a specific state.
ValueValue De waarde om toe te wijzen aan de omgevingsvariabele.The value to assign to the environment variable.
Zorg ervoor datEnsure Bepaalt of Controleer of de variabele bestaat.Determines whether to check if the variable exists. Deze eigenschap instellen op 'Aanwezig' om te controleren of dat de variabele bestaat.Set this property to "Present" to ensure the variable exists. Stel deze in op 'Ontbreekt' om te controleren of dat de variabele bestaat niet.Set it to "Absent" to ensure the variable does not exist. De standaardwaarde is 'Aanwezig'.The default value is "Present".
PadPath Hiermee definieert u de variabele die wordt geconfigureerd.Defines the environment variable that is being configured. Deze eigenschap instellen op $true als de variabele de pad variabele, anders wordt ingesteld op $false.Set this property to $true if the variable is the Path variable; otherwise, set it to $false. De standaardwaarde is $false.The default is $false. Als de variabele die wordt geconfigureerd de pad variabele, de waarde wordt opgegeven via de waarde eigenschap worden toegevoegd aan de bestaande waarde.If the variable being configured is the Path variable, the value provided through the Value property will be appended to the existing value.
dependsOnDependsOn Hiermee wordt aangegeven dat de configuratie van een andere resource uitvoeren moet voordat deze bron is geconfigureerd.Indicates that the configuration of another resource must run before this resource is configured. Bijvoorbeeld, als de ID van de resource is scriptblok configuratie die u wilt uitvoeren eerst ResourceName en het type ResourceType, de syntaxis voor het gebruik van deze de eigenschap is DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".

Als u meer informatieAdditional Information

  • Als pad ontbreekt of is ingesteld op $false, omgevingsvariabelen worden beheerd in /etc/environment.If Path is absent or set to $false, environment variables are managed in /etc/environment. Uw programma's of scripts mogelijk configuratie bron vereist de /etc/environment bestand voor toegang tot de beheerde omgevingsvariabelen.Your programs or scripts may require configuration to source the /etc/environment file to access the managed environment variables.
  • Als pad is ingesteld op $true, de omgevingsvariabele wordt beheerd in het bestand /etc/profile.d/DSCenvironment.sh.If Path is set to $true, the environment variable is managed in the file /etc/profile.d/DSCenvironment.sh. Dit bestand wordt gemaakt als deze niet bestaat.This file will be created if it does not exist. Als Zorg ervoor dat is ingesteld op 'Afwezig' en pad is ingesteld op $true, een bestaande omgevingsvariabele wordt alleen verwijderd uit /etc/profile.d/DSCenvironment.sh en niet vanuit andere bestanden.If Ensure is set to "Absent" and Path is set to $true, an existing environment variable will only be removed from /etc/profile.d/DSCenvironment.sh and not from other files.

VoorbeeldExample

Het volgende voorbeeld ziet u hoe u de nxEnvironment resource ervoor te zorgen dat TestEnvironmentVariable aanwezig is en de waarde 'Test-waarde'.The following example shows how to use the nxEnvironment resource to ensure that TestEnvironmentVariable is present and has the value "Test-Value". Als TestEnvironmentVariable is niet aanwezig is, wordt deze gemaakt.If TestEnvironmentVariable is not present, it will be created.

Import-DSCResource -Module nx


nxEnvironment EnvironmentExample
{
    Ensure = “Present”
    Name = “TestEnvironmentVariable”
    Value = “TestValue”
}