Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.72 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.72 KB
Raw

Carbon.Accounts PowerShell Module Overview

The "Carbon.Accounts" module has functions for managing groups, checking if accounts exist, getting canonical account metadata/information, and works with SIDs (security identifiers).

System Requirements

  • Most functions are Windows-only.
  • Windows PowerShell 5.1 and .NET 4.6.1+
  • PowerShell Core 7+

Note that local group functions are not supported on 32-bit PowerShell on a 64-bit operating system.

Installing

To install globally:

Install-Module -Name 'Carbon.Accounts'
Import-Module -Name 'Carbon.Accounts'

To install privately:

Save-Module -Name 'Carbon.Accounts' -Path '.'
Import-Module -Name '.\Carbon.Accounts'

Commands

  • ConvertTo-CSecurityIdentifier: converts a string or byte array security identifier into a System.Security.Principal.SecurityIdentifier object.
  • Get-CLocalGroup: gets local groups.
  • Install-CLocalGroup: creates a new local group, or updates the settings for an existing group.
  • Install-CLocalGroupMember: adds a users or groups to a local group.
  • Resolve-CPrincipal: gets domain, name, type, and SID information about a user or group.
  • Resolve-CPrincipalName: determines the full, NT principal name for a user or group.
  • Test-CPrincipal: Tests that a name is a valid Windows local or domain user/group.
  • Test-CLocalGroup: checks if a local group exists.
  • Test-CLocalGroupMember: tests if an account is a member of a local group.
  • Uninstall-CLocalGroup: deletes a local group if it exists.
  • Uninstall-CLocalGroupMember: removes accounts from a local group if those accounts are in the group.