Ресурс nxEnvironment в DSC для Linux

Статья
03/09/2024

Ресурс nxEnvironment в DSC PowerShell предоставляет механизм управления системными переменными среды на узле Linux.

Синтаксис

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

Свойства

Свойство	Описание
Имя	Указывает имя переменной среды, для которой требуется обеспечить определенное состояние.
Значение	Значение, которое нужно присвоить переменной среды.
путь	Определяет настраиваемую переменную среды. Для переменной Path присвойте этому свойству значение `$true`; для остальных переменных используйте значение `$false`. Значение по умолчанию — `$false`. Если настраивается переменная Path, к существующему значению прикрепляется значение свойства Value.

Общие свойства

Свойство Описание

DependsOn Указывает, что перед настройкой этого ресурса необходимо запустить настройку другого ресурса. Например, если идентификатор первого запускаемого блока сценария для конфигурации ресурса — ResourceName, а его тип — ResourceType, то синтаксис использования этого свойства таков: DependsOn = "[ResourceType]ResourceName".

Ensure Определяет, нужно ли проверять существование переменной. Чтобы гарантировать, что переменная существует, укажите для этого свойства значение Present. Чтобы гарантировать, что переменная не существует, укажите для этого свойства значение Absent. Значение по умолчанию — Present.

Свойство	Описание
DependsOn	Указывает, что перед настройкой этого ресурса необходимо запустить настройку другого ресурса. Например, если идентификатор первого запускаемого блока сценария для конфигурации ресурса — ResourceName, а его тип — ResourceType, то синтаксис использования этого свойства таков: `DependsOn = "[ResourceType]ResourceName"`.
Ensure	Определяет, нужно ли проверять существование переменной. Чтобы гарантировать, что переменная существует, укажите для этого свойства значение Present. Чтобы гарантировать, что переменная не существует, укажите для этого свойства значение Absent. Значение по умолчанию — Present.

Дополнительные сведения

Если свойство Path не задано или имеет значение $false, управление переменными среды осуществляется в файле /etc/environment. Для доступа к управляемым переменным среды может потребоваться настроить файл /etc/environment в качестве источника для программ или сценариев.
Если свойство Path имеет значение $true, управление переменными среды осуществляется в файле /etc/profile.d/DSCenvironment.sh. Если этот файл не существует, он будет создан. Если свойство Ensure имеет значение Absent, а свойство Path — значение $true, существующая переменная среды будет удалена только из файла /etc/profile.d/DSCenvironment.sh; остальные файлы затронуты не будут.

Пример

В следующем примере показано, как использовать ресурс nxEnvironment, чтобы убедиться, что переменная TestEnvironmentVariable существует и имеет значение Test-Value. Если переменная TestEnvironmentVariable не существует, она будет создана.

Import-DSCResource -ModuleName nx

nxEnvironment EnvironmentExample
{
    Ensure = "Present"
    Name = "TestEnvironmentVariable"
    Value = "TestValue"
}