PoShPACLI

2.0.20

Functions/UserMangement/New-PVLDAPBranch.ps1

Function New-PVLDAPBranch {

    <#
    .SYNOPSIS
    Adds an LDAP branch to an existing CyberArk Directory Map
 
    .DESCRIPTION
    Exposes the PACLI Function: "LDAPBRANCHADD"
 
    .PARAMETER ldapMapName
    The name of the Directory Map where the LDAP branch will be added.
 
    .PARAMETER ldapDirName
    The name of the LDAP directory.
 
    .PARAMETER ldapBranchName
    The DN of the LDAP directory branch.
 
    .PARAMETER ldapQuery
    The LDAP filter that is applied to objects in the specified branch.
 
    .PARAMETER ldapGroupMatch
    A regular expression used to filter LDAP groups of objects in the branch.
 
    .EXAMPLE
    New-PVLDAPBranch -ldapMapName "Vault Users Mapping" -ldapDirName Domain.COM `
    -ldapBranchName "DC=Domain,DC=Com" -ldapQuery "samaccountname=this_user"
 
    Adds LDAP Branch to Vault Users Mapping with specified LDAP Query
 
    .NOTES
    AUTHOR: Pete Maan
 
    #>

    [CmdLetBinding(SupportsShouldProcess)]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification = "ShouldProcess handling is in Invoke-PACLICommand")]
    param(

        [Parameter(
            Mandatory = $True,
            ValueFromPipelineByPropertyName = $True)]
        [string]$ldapMapName,

        [Parameter(
            Mandatory = $True,
            ValueFromPipelineByPropertyName = $True)]
        [string]$ldapDirName,

        [Parameter(
            Mandatory = $True,
            ValueFromPipelineByPropertyName = $True)]
        [string]$ldapBranchName,

        [Parameter(
            Mandatory = $False,
            ValueFromPipelineByPropertyName = $True)]
        [string]$ldapQuery,

        [Parameter(
            Mandatory = $False,
            ValueFromPipelineByPropertyName = $True)]
        [string]$ldapGroupMatch
    )

    PROCESS {

        $Return = Invoke-PACLICommand $Script:PV.ClientPath LDAPBRANCHADD "$($PSBoundParameters | ConvertTo-ParameterString) OUTPUT (ALL,ENCLOSE)"

        if ($Return.ExitCode -eq 0) {

            #if result(s) returned
            if ($Return.StdOut) {

                #Convert Output to array
                $Results = $Return.StdOut | ConvertFrom-PacliOutput

                #loop through results
                For ($i = 0 ; $i -lt $Results.length ; $i += 7) {

                    #Get Range from array
                    $values = $Results[$i..($i + 7)]

                    #Output Object
                    [PSCustomObject] @{

                        #assign values to properties
                        "LDAPBranchID"   = $values[0]
                        "LDAPMapID"      = $values[1]
                        "LDAPMapName"    = $values[2]
                        "LDAPDirName"    = $values[3]
                        "LDAPBranchName" = $values[4]
                        "LDAPQuery"      = $values[5]
                        "LDAPGroupMatch" = $values[6]

                    } | Add-ObjectDetail -TypeName pacli.PoShPACLI.LDAP.Branch

                }

            }

        }

    }

}