DSC WindowsFeature 資源
適用於:Windows PowerShell 4.0、Windows PowerShell 5.x
Windows PowerShell 預期狀態設定 (DSC) 的 WindowsFeature 資源提供一個機制,確保可在目標節點上新增或移除角色和功能。
注意
此 DSC 資源的本檔涵蓋 7.2 版之前 PowerShell 隨附的版本。 PSDscResources模組包含 Microsoft 正式支援的全新和更新 DSC 資源。 PSDscResources 模組可從 PowerShell 資源庫中取得。
如需詳細資訊和更新的檔,請參閱 PSDscResources 參考檔。
語法
WindowsFeature [string] #ResourceName
{
Name = [string]
[ Credential = [PSCredential] ]
[ IncludeAllSubFeature = [bool] ]
[ LogPath = [string] ]
[ DependsOn = [string[]] ]
[ Ensure = [string] { Absent | Present } ]
[ PsDscRunAsCredential = [PSCredential] ]
}
屬性
屬性 | 描述 |
---|---|
名稱 | 表示您想要確保新增或移除的角色或功能名稱。 這與來自 Get-WindowsFeature Cmdlet 的 Name 屬性相同,不是角色或功能的顯示名稱。 |
認證 | 表示要用以新增或移除角色或功能的認證。 |
IncludeAllSubFeature | 將此屬性設定為 $true 可讓您使用以 Name 屬性指定的功能狀態,來確保所有必要子功能的狀態。 |
LogPath | 表示要讓資源提供者記錄作業的記錄檔路徑。 |
通用屬性
屬性 | 描述 |
---|---|
DependsOn | 表示必須先執行另一個資源的設定,再設定這個資源。 例如,如果第一個想要執行的資源設定指令碼區塊識別碼是 ResourceName,而其類型是 ResourceType,則使用這個屬性的語法就是 DependsOn = "[ResourceType]ResourceName" 。 |
Ensure | 表示角色或功能是否新增。 若要確保新增角色或功能,請將此屬性設定為 Present。 若要確保移除角色或功能,請將此屬性設定為 Absent。 預設值為 Present。 |
PsDscRunAsCredential | 設定用於執行整個資源的認證。 |
注意
已在 WMF 5.0 中新增 PsDscRunAsCredential 通用屬性,以允許在其他認證的內容中執行任何 DSC 資源。 如需詳細資訊,請參閱搭配 DSC 資源使用認證。
範例
WindowsFeature RoleExample
{
Ensure = "Present"
# Alternatively, to ensure the role is uninstalled, set Ensure to "Absent"
Name = "Web-Server" # Use the Name property from Get-WindowsFeature
}