Carbon

2.5.0

Carbon is a PowerShell module for automating the configuration Windows 7, 8, 2008, and 2012 and automation the installation and configuration of Windows applications, websites, and services. It can configure and manage:

* Local users and groups
* IIS websites, virtual directories, and applications
* File system, registry, and certificate permissions
* Certif
Carbon is a PowerShell module for automating the configuration Windows 7, 8, 2008, and 2012 and automation the installation and configuration of Windows applications, websites, and services. It can configure and manage:

* Local users and groups
* IIS websites, virtual directories, and applications
* File system, registry, and certificate permissions
* Certificates
* Privileges
* Services
* Encryption
* Junctions
* Hosts file
* INI files
* Performance counters
* Shares
* .NET connection strings and app settings
* And much more!

All functions are idempotent: when run multiple times with the same arguments, your system will be in the same state without failing or producing errors.
Show more

Minimum PowerShell version

4.0

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name Carbon -RequiredVersion 2.5.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name Carbon -Version 2.5.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

Copyright 2011 - 2016 Aaron Jensen.

Package Details

Author(s)

  • Aaron Jensen

Tags

.net acl active-directory certificates com compression computer credential cryptography directory dsc dsc-resources encryption environment file-system firewall groups hosts-file http identity iis ini installers internet-explorer ip junctions msi msmq netsh networking ntfs operating-system os path performance-counters powershell principal privileges programs registry rsa scheduled-tasks security service shares sid smb ssl text trusted-host users wcf windows windows-features xml zip DscResources setup automation admin

Functions

Add-GroupMember Add-IisDefaultDocument Add-TrustedHost Assert-AdminPrivilege Assert-FirewallConfigurable Assert-Service Clear-DscLocalResourceCache Clear-MofAuthoringMetadata Clear-TrustedHost Complete-Job Compress-Item ConvertFrom-Base64 Convert-SecureStringToString ConvertTo-Base64 ConvertTo-ContainerInheritanceFlags ConvertTo-InheritanceFlag ConvertTo-PropagationFlag ConvertTo-SecurityIdentifier Convert-XmlFile Copy-DscResource Disable-AclInheritance Disable-FirewallStatefulFtp Disable-IEEnhancedSecurityConfiguration Disable-IisSecurityAuthentication Disable-NtfsCompression Enable-AclInheritance Enable-FirewallStatefulFtp Enable-IEActivationPermission Enable-IisDirectoryBrowsing Enable-IisSecurityAuthentication Enable-IisSsl Enable-NtfsCompression Expand-Item Find-ADUser Format-ADSearchFilterValue Get-ADDomainController Get-Certificate Get-CertificateStore Get-ComPermission Get-ComSecurityDescriptor Get-DscError Get-DscWinEvent Get-FileShare Get-FileSharePermission Get-FirewallRule Get-Group Get-HttpUrlAcl Get-IisApplication Get-IisAppPool Get-IisConfigurationSection Get-IisHttpHeader Get-IisHttpRedirect Get-IisMimeMap Get-IisSecurityAuthentication Get-IisVersion Get-IisWebsite Get-IPAddress Get-Msi Get-MsmqMessageQueue Get-MsmqMessageQueuePath Get-PathProvider Get-PathToHostsFile Get-PerformanceCounter Get-Permission Get-PowerShellModuleInstallPath Get-PowershellPath Get-Privilege Get-ProgramInstallInfo Get-RegistryKeyValue Get-ScheduledTask Get-ServiceAcl Get-ServiceConfiguration Get-ServicePermission Get-ServiceSecurityDescriptor Get-SslCertificateBinding Get-TrustedHost Get-User Get-WindowsFeature Get-WmiLocalUserAccount Grant-ComPermission Grant-HttpUrlPermission Grant-MsmqMessageQueuePermission Grant-Permission Grant-Privilege Grant-ServiceControlPermission Grant-ServicePermission Initialize-Lcm Install-Certificate Install-Directory Install-FileShare Install-Group Install-IisApplication Install-IisAppPool Install-IisVirtualDirectory Install-IisWebsite Install-Junction Install-Msi Install-Msmq Install-MsmqMessageQueue Install-PerformanceCounter Install-RegistryKey Install-ScheduledTask Install-Service Install-User Install-WindowsFeature Invoke-AppCmd Invoke-PowerShell Join-IisVirtualPath Lock-IisConfigurationSection New-Credential New-Junction New-RsaKeyPair New-TempDirectory Protect-String Read-File Remove-DotNetAppSetting Remove-EnvironmentVariable Remove-GroupMember Remove-HostsEntry Remove-IisMimeMap Remove-IniEntry Remove-Junction Remove-RegistryKeyValue Remove-SslCertificateBinding Reset-HostsFile Reset-MsmqQueueManagerID Resolve-FullPath Resolve-Identity Resolve-IdentityName Resolve-NetPath Resolve-PathCase Resolve-RelativePath Restart-RemoteService Revoke-ComPermission Revoke-HttpUrlPermission Revoke-Permission Revoke-Privilege Revoke-ServicePermission Set-DotNetAppSetting Set-DotNetConnectionString Set-EnvironmentVariable Set-HostsEntry Set-IisHttpHeader Set-IisHttpRedirect Set-IisMimeMap Set-IisWebsiteID Set-IisWebsiteSslCertificate Set-IisWindowsAuthentication Set-IniEntry Set-RegistryKeyValue Set-ServiceAcl Set-SslCertificateBinding Set-TrustedHost Split-Ini Start-DscPullConfiguration Test-AdminPrivilege Test-DotNet Test-DscTargetResource Test-FileShare Test-FirewallStatefulFtp Test-Group Test-GroupMember Test-Identity Test-IisAppPool Test-IisConfigurationSection Test-IisSecurityAuthentication Test-IisWebsite Test-IPAddress Test-MsmqMessageQueue Test-NtfsCompression Test-OSIs32Bit Test-OSIs64Bit Test-PathIsJunction Test-PerformanceCounter Test-PerformanceCounterCategory Test-Permission Test-PowerShellIs32Bit Test-PowerShellIs64Bit Test-Privilege Test-RegistryKeyValue Test-ScheduledTask Test-Service Test-SslCertificateBinding Test-TypeDataMember Test-UncPath Test-User Test-WindowsFeature Test-ZipFile Uninstall-Certificate Uninstall-Directory Uninstall-FileShare Uninstall-Group Uninstall-IisAppPool Uninstall-IisWebsite Uninstall-Junction Uninstall-MsmqMessageQueue Uninstall-PerformanceCounterCategory Uninstall-ScheduledTask Uninstall-Service Uninstall-User Uninstall-WindowsFeature Unlock-IisConfigurationSection Unprotect-String Write-DscError Write-File

DSCResources

Carbon_EnvironmentVariable Carbon_FirewallRule Carbon_Group Carbon_IniFile Carbon_Permission Carbon_Privilege Carbon_ScheduledTask Carbon_Service

Dependencies

This module has no dependencies.

Release Notes

## Enhancements

* Added `DelayedAutoStart` boolean property to objects returned by `Get-ServiceConfiguration`. This flag is `true` when a service is set to start automatically, delayed. `False` otherwise. Added extended
* The `Install-Service` function and the `Carbon_Service` DSC resource can now set a service's startup type to `Automatic (Delayed)`. Pass `Automatic` to the `StartupType` parameter and use the new `Delayed` switch. The `Delayed` switch is ignored unless `StartupType` is `Automatic`. Fixes [issue #216](https://bitbucket.org/splatteredbits/carbon/issues/216/community-add-automaticdelayed-in).
* The `Uninstall-Certificate` function can now delete a certificate by just its thumbprint. The certificate will be uninstalled from *all* stores. You can pipe the thumbprint or a certificate object to `Uninstall-Certificate`.
* Added an `EnsureRunning` switch to `Install-Service` function to ensure that any service is started after configuring. (By default, `Install-Service` leaves a service stopped if it was stopped when `Install-Service` begins.)
* Added `IsSymbolicLink` extended type property to directory and file objects (i.e. `System.IO.DirectoryInfo` and `System.IO.FileInfo` objects).
* Added `TargetPath` extended type property to file (i.e. `System.IO.FileInfo`) objects. If a file is a symbolic link, this property will return the file the link points to.
* The `TargetPath` extended type property on directory (i.e. `System.IO.DirectoryInfo) objects now returns target paths when a directory is a symbolic link.
* `Initiazlie-Lcm` can't be used on Windows Server 2016 and later to put the DSC local configuration manager into pull mode. `Initialize-Lcm` now writes an error when you try.

## Bug Fixes

* `Install-Service` and the `Carbon_Service` DSC resource write errors when a service is running and its startup type is changed to `Disabled`.
* The `Carbon_ScheduledTask` DSC resource writes incorrect information to verbose log when the current and desired credential for the scheduled task are different.
* The `Carbon_ScheduledTask` DSC resource doesn't correctly detect when a task's identity has changed (it wasn't converting usernames to their canonical representation before comparing the existing identity with the desired identity).
* Fixed: Importing Carbon in 32-bit PowerShell fails on a 64-bit operating system. DSC isn't available so the `Initialize-Lcm` function can't be exported. Thanks to [Anders Andersson](https://bitbucket.org/McAndersDK/) for contribuging the fix.
* Fixed: `Install-Service` and `Carbon_Service` DSC resource fail to change the identity a service runs as if switching from a custom account to the default `NetworkService` account.
* Fixed: `Get-PowerShellModuleInstallPath` returns nothing when run under 32-bit (x86) PowerShell on 64-bit Windows.Fixed: `Get-PowerShellModuleInstallPath` returns nothing when run under 32-bit (x86) PowerShell on 64-bit Windows.

FileList

Version History

Version Downloads Last updated
2.16.0-rc1 41 3/19/2024
2.15.1 7,611,087 8/18/2023
2.15.0 37,696 8/17/2023
2.14.1 1,428,601 7/5/2023
2.14.1-rc1 13 7/3/2023
2.14.0 75,143 7/3/2023
2.14.0-rc1 103 5/10/2023
2.13.0 4,694,248 2/16/2023
2.13.0-rc2 94 1/20/2023
2.13.0-rc1 5 1/20/2023
2.12.0 6,366,573 8/10/2022
2.11.3 1,366,285 6/30/2022
2.11.2 3,080,948 3/28/2022
2.11.1 943,188 2/28/2022
2.11.1-alpha732 571 2/28/2022
2.11.0 3,795,684 11/3/2021
2.11.0-rc710 607 10/19/2021
2.11.0-rc707 567 10/19/2021
2.10.2 7,140,063 3/17/2021
2.10.1 26,452 3/16/2021
2.10.1-rc660 610 3/8/2021
2.10.0 22,962 3/15/2021
2.10.0-rc651 726 2/3/2021
2.9.4 3,002,269 12/8/2020
2.9.3 607,166 11/18/2020
2.9.3-rc623 628 10/9/2020
2.9.2 14,020,766 1/17/2020
2.9.1 1,546,516 11/1/2019
2.9.0 995,079 9/19/2019
2.9.0-rc587 586 9/16/2019
2.8.1 4,228,475 3/26/2019
2.8.0 31,745 3/25/2019
2.7.0 3,922,460 12/11/2018
2.6.0 5,440,781 7/8/2018
2.5.4 206,543 6/2/2018
2.5.3 1,339 6/1/2018
2.5.2 233 6/1/2018
2.5.1 247 6/1/2018
2.5.0 (current version) 828,397 6/18/2017
2.4.1 242,670 2/21/2017
2.4.0 124,348 11/9/2016
2.3.0 39,270 9/29/2016
2.2.0 22,401 5/12/2016
2.1.1 1,220 2/25/2016
2.1.0 553 2/9/2016
2.0.1 1,068 10/20/2015
2.0.0 1,898 10/11/2015
1.9.0 1,460 5/7/2015
Show less