Skip to content

Latest commit

 

History

History
99 lines (87 loc) · 2.74 KB

README.md

File metadata and controls

99 lines (87 loc) · 2.74 KB

CyberArkDsc

A PowerShell DSC module for CyberArk's Privileged Access Manager objects (Accounts, Safes, Platforms, etc.).

It currently contains the following resources:

  • CYA_Account
  • CYA_Safe
  • CYA_SafeMember

Installation

Ensure the psPAS module and the CyberArkDsc folder is in a location listed under $env:PSModulePath that the SYSTEM account can access. Example: C:\Program Files\WindowsPowerShell\Modules\

Resources

CYA_Account

CYA_Account [String] #ResourceName
{
    Address = [string]
    AuthenticationType = [string]
    Credential = [PSCredential]
    Ensure = [string]{ Absent | Present }
    PlatformId = [string]
    PvwaUrl = [string]
    SafeName = [string]
    SkipCertificateCheck = [bool]
    UserName = [string]
    [DependsOn = [string[]]]
    [LogonAccount = [HashTable]]
    [Name = [string]]
    [Password = [PSCredential]]
    [PsDscRunAsCredential = [PSCredential]]
    [ReconcileAccount = [HashTable]]
}

CYA_Safe

CYA_Safe [String] #ResourceName
{
    AuthenticationType = [string]
    Credential = [PSCredential]
    Ensure = [string]{ Absent | Present }
    PvwaUrl = [string]
    SafeName = [string]
    [DependsOn = [string[]]]
    [Description = [string]]
    [ManagingCPM = [string]]
    [NumberOfDaysRetention = [string]]
    [NumberOfVersionsRetention = [string]]
    [PsDscRunAsCredential = [PSCredential]]
    [SkipCertificateCheck = [bool]]
}

CYA_SafeMember

CYA_SafeMember [String] #ResourceName
{
    AuthenticationType = [string]
    Credential = [PSCredential]
    Ensure = [string]{ Absent | Present }
    MemberName = [string]
    PvwaUrl = [string]
    SafeName = [string]
    SearchIn = [string]
    [AccessWithoutConfirmation = [bool]]
    [AddAccounts = [bool]]
    [BackupSafe = [bool]]
    [CreateFolders = [bool]]
    [DeleteAccounts = [bool]]
    [DeleteFolders = [bool]]
    [DependsOn = [string[]]]
    [InitiateCPMAccountManagementOperations = [bool]]
    [ListAccounts = [bool]]
    [ManageSafe = [bool]]
    [ManageSafeMembers = [bool]]
    [MembershipExpirationDate = [DateTime]]
    [MoveAccountsAndFolders = [bool]]
    [PsDscRunAsCredential = [PSCredential]]
    [RenameAccounts = [bool]]
    [requestsAuthorizationLevel1 = [bool]]
    [requestsAuthorizationLevel2 = [bool]]
    [RetrieveAccounts = [bool]]
    [SkipCertificateCheck = [bool]]
    [SpecifyNextAccountContent = [bool]]
    [UnlockAccounts = [bool]]
    [UpdateAccountContent = [bool]]
    [UpdateAccountProperties = [bool]]
    [UseAccounts = [bool]]
    [ViewAuditLog = [bool]]
    [ViewSafeMembers = [bool]]
}