Recurso nxEnvironment de DSC para LinuxDSC for Linux nxEnvironment Resource

O recurso nxEnvironment na Configuração de Estado Desejado (DSC) do PowerShell fornece um mecanismo para gerenciar as variáveis de ambiente do sistema em um nó do Linux.The nxEnvironment resource in PowerShell Desired State Configuration (DSC) provides a mechanism to to manage system environment variables on a Linux node.

SintaxeSyntax

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

}

PropriedadesProperties

PropriedadeProperty DescriçãoDescription
NomeName Indica o nome da variável de ambiente para a qual você deseja garantir um estado específico.Indicates the name of the environment variable for which you want to ensure a specific state.
ValorValue O valor que será atribuído à variável de ambiente.The value to assign to the environment variable.
EnsureEnsure Determina se é necessário verificar se a variável existe.Determines whether to check if the variable exists. Defina essa propriedade como "Present" para garantir que a variável exista.Set this property to "Present" to ensure the variable exists. Defina-a como "Absent" para garantir que a variável não exista.Set it to "Absent" to ensure the variable does not exist. O valor padrão é "Present".The default value is "Present".
CaminhoPath Define a variável de ambiente que está sendo configurada.Defines the environment variable that is being configured. Defina essa propriedade como $true se a variável for a variável Path; caso contrário, defina-a como $false.Set this property to $true if the variable is the Path variable; otherwise, set it to $false. O padrão é $false.The default is $false. Se a variável que estiver sendo configurada for a variável Path, o valor fornecido por meio da propriedade Value será acrescentado ao valor existente.If the variable being configured is the Path variable, the value provided through the Value property will be appended to the existing value.
DependsOnDependsOn Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado.Indicates that the configuration of another resource must run before this resource is configured. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será 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".

Informações adicionaisAdditional Information

  • Se Path estiver ausente ou configurado como $false, as variáveis de ambiente serão gerenciadas em /etc/environment.If Path is absent or set to $false, environment variables are managed in /etc/environment. Seus programas ou scripts poderão exigir uma configuração para fornecer o arquivo /etc/environment para acessar as variáveis de ambiente gerenciadas.Your programs or scripts may require configuration to source the /etc/environment file to access the managed environment variables.
  • Se Path estiver definido como $true, a variável de ambiente será gerenciada no arquivo /etc/profile.d/DSCenvironment.sh.If Path is set to $true, the environment variable is managed in the file /etc/profile.d/DSCenvironment.sh. Esse arquivo será criado se não existir.This file will be created if it does not exist. Se Ensure estiver definido com "Absent" e Path estiver definido como $true, uma variável de ambiente existente será removida apenas de /etc/profile.d/DSCenvironment.sh e não de outros arquivos.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.

ExemploExample

O exemplo a seguir mostra como usar o recurso nxEnvironment para garantir que TestEnvironmentVariable esteja presente e tenha o valor "Test-Value".The following example shows how to use the nxEnvironment resource to ensure that TestEnvironmentVariable is present and has the value "Test-Value". Se TestEnvironmentVariable não estiver presente, será criado.If TestEnvironmentVariable is not present, it will be created.

Import-DSCResource -Module nx 


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