AsBuiltReport.Aruba.ClearPass

0.1.1

Src/Private/Get-AbrCPPMService.ps1

function Get-AbrCPPMService {
    <#
    .SYNOPSIS
        Used by As Built Report to returns Service settings.
    .DESCRIPTION
        Documents the configuration of Aruba ClearPass in Word/HTML/Text formats using PScribo.
    .NOTES
        Version: 0.1.0
        Author: Alexis La Goutte
        Twitter: @alagoutte
        Github: alagoutte
        Credits: Iain Brighton (@iainbrighton) - PScribo module
 
    .LINK
        https://github.com/AsBuiltReport/AsBuiltReport.Aruba.ClearPass
    #>
    [CmdletBinding()]
    param (

    )

    begin {
        Write-PScriboMessage "Discovering Service settings information from $System."
    }

    process {
        Section -Style Heading2 'Service' {
            Paragraph "The following section details Service settings configured on ClearPass."
            BlankLine

            $service = Get-ArubaCPService -limit 1000 | Sort-Object order_no

            if ( $defaultArubaCPConnection.version -gt [version]"6.11.0") {
                $enf_policy = Get-ArubaCPEnforcementPolicy -limit 1000
                $enf_profile = Get-ArubaCPEnforcementProfile -limit 1000
            }

            if ($service -and $InfoLevel.Service -ge 1) {
                Section -Style Heading3 'Summary' {
                    Paragraph "The following section details Settings Summary configured on ClearPass."
                    BlankLine

                    #Service, Enforcement (policy or profile) start with [ is configured by default (factory) on Clearpass
                    $service_count = @($Service).count
                    $service_count_default = @($service | Where-Object { $_.name -like '`[*' }).Count

                    $service_count_enabled = @($Service | Where-Object { $_.enabled -eq 'true' }).count
                    $service_count_enabled_default = @($service | Where-Object { $_.name -like '`[*' -and $_.enabled -eq 'true' }).Count

                    $OutObj = @()
                    $OutObj = [pscustomobject]@{
                        "Service"         = "$service_count (default: $service_count_default)"
                        "Service Enabled" = "$service_count_enabled (default: $service_count_enabled_default)"
                    }

                    if ( $defaultArubaCPConnection.version -gt [version]"6.11.0") {
                        $enf_policy_count = @($enf_policy).count
                        $enf_policy_count_default = @($enf_policy | Where-Object { $_.name -like '`[*' }).count

                        $enf_profile_count = @($enf_profile).count
                        $enf_profile_count_default = @($enf_profile | Where-Object { $_.name -like '`[*' }).count
                        $OutObj | Add-Member -MemberType NoteProperty -Name "Enforcement Policy" -Value "$enf_policy_count (default: $enf_policy_count_default)"
                        $OutObj | Add-Member -MemberType NoteProperty -Name "Enforcement Profile" -Value "$enf_profile_count (default: $enf_profile_count_default)"
                    }

                    $TableParams = @{
                        Name         = "Service Summary"
                        List         = $true
                        ColumnWidths = 50, 50
                    }

                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }

                    $OutObj | Table @TableParams

                }
            }

            if ($service -and $InfoLevel.service -ge 1) {
                Section -Style Heading3 'Service' {
                    Paragraph "The following section details Service configured on ClearPass."
                    BlankLine

                    $OutObj = @()
                    foreach ($srvc in $Service) {
                        $OutObj += [pscustomobject]@{
                            "Id"      = $srvc.id
                            "Name"    = $srvc.name
                            "Type"    = $srvc.type
                            "Enabled" = $srvc.enabled
                            "No"      = $srvc.order_no
                            "Policy"  = $srvc.enf_policy
                        }
                    }

                    $TableParams = @{
                        Name         = "Service"
                        List         = $false
                        ColumnWidths = 10, 30, 15, 10, 5, 30
                    }

                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }

                    $OutObj | Table @TableParams

                    if ($InfoLevel.service -ge 2) {

                        Paragraph "The following section details Service configured on ClearPass."
                        BlankLine
                        foreach ($srvc in $Service) {
                            Section -Style Heading3 "Service: $($srvc.name)" {
                                $OutObj = @()

                                if ( $defaultArubaCPConnection.version -gt [version]"6.11.0") {
                                    $OutObj = [pscustomobject]@{
                                        "Name"               = $srvc.name
                                        "Type"               = $srvc.type
                                        "Template"           = $srvc.template
                                        "Enabled"            = $srvc.enabled
                                        #"Hit Count" = $srvc.hit_count
                                        "Order No"           = $srvc.order_no
                                        "Description"        = $srvc.description
                                        "Monitor Mode"       = $srvc.monitor_mode
                                        "Auth Sources"       = $srvc.auth_sources -join ", "
                                        "Auth zSources"      = $srvc.authz_sources -join ", "
                                        "Strip Username"     = $srvc.strip_username
                                        "Enforcement Policy" = $srvc.enf_policy
                                        "Rules Match Type"   = $srvc.rules_match_type
                                    }
                                }
                                else {
                                    #Missing fields with CPPM < 6.11.0...
                                    $OutObj = [pscustomobject]@{
                                        "Name"     = $srvc.name
                                        "Type"     = $srvc.type
                                        "Template" = $srvc.template
                                        "Enabled"  = $srvc.enabled
                                        #"Hit Count" = $srvc.hit_count
                                        "Order No" = $srvc.order_no
                                    }
                                }

                                $TableParams = @{
                                    Name         = "Service: $($srvc.name)"
                                    List         = $true
                                    ColumnWidths = 20, 80
                                }

                                if ($Report.ShowTableCaptions) {
                                    $TableParams['Caption'] = "- $($TableParams.Name)"
                                }

                                $OutObj | Table @TableParams

                                #Rules Conditions
                                if ($srvc.rules_conditions) {
                                    $OutObj = @()
                                    foreach ($rule in $srvc.rules_conditions) {

                                        $OutObj += [pscustomobject]@{
                                            "Type"     = $rule.type
                                            "Name"     = $rule.name
                                            "Operator" = $rule.operator
                                            "Value"    = $rule.value
                                        }
                                    }

                                    $TableParams = @{
                                        Name         = "Rules Conditions: $($srvc.name)"
                                        List         = $false
                                        ColumnWidths = 25, 30, 10, 35
                                    }

                                    if ($Report.ShowTableCaptions) {
                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                    }

                                    $OutObj | Table @TableParams
                                }
                            }
                        }
                    }
                }
            }

            if ($enf_policy -and $InfoLevel.service -ge 1) {
                Section -Style Heading3 'Enforcement Policy' {
                    Paragraph "The following section details Enforcement Policy configured on ClearPass."
                    BlankLine

                    $OutObj = @()
                    foreach ($policy in $enf_policy) {
                        $OutObj += [pscustomobject]@{
                            "Id"          = $policy.id
                            "Name"        = $policy.name
                            "Type"        = $policy.enforcement_type
                            "Default"     = $policy.default_enforcement_profile
                            "Rule Algo"   = $policy.rule_eval_algo
                            "Rules Count" = @($policy.rules).count
                            "Ref"         = @($service | Where-Object { $_.enf_policy -eq $policy.name }).count
                        }
                    }

                    $TableParams = @{
                        Name         = "Enforcement Policy"
                        List         = $false
                        ColumnWidths = 7, 30, 14, 15, 20, 7, 7
                    }

                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }

                    $OutObj | Table @TableParams

                    if ($InfoLevel.service -ge 2) {

                        Paragraph "The following section details Enforcement Policy configured on ClearPass."
                        BlankLine
                        foreach ($policy in $enf_policy) {
                            Section -Style Heading3 "Enforcement Policy: $($policy.name)" {
                                $OutObj = @()

                                $OutObj = [pscustomobject]@{
                                    "Id"        = $policy.id
                                    "Name"      = $policy.name
                                    "Type"      = $policy.enforcement_type
                                    "Default"   = $policy.default_enforcement_profile
                                    "Rule Algo" = $policy.rule_eval_algo
                                }

                                $TableParams = @{
                                    Name         = "Enforcement Policy: $($policy.name)"
                                    List         = $true
                                    ColumnWidths = 20, 80
                                }

                                if ($Report.ShowTableCaptions) {
                                    $TableParams['Caption'] = "- $($TableParams.Name)"
                                }

                                $OutObj | Table @TableParams

                                #Rules Conditions
                                if ($policy.rules) {
                                    $OutObj = @()
                                    foreach ($rule in $policy.rules) {
                                        $conditions = ""
                                        foreach ($condition in $rule.condition) {
                                            if ($conditions) {
                                                $conditions += " AND "
                                            }
                                            $conditions += "($($condition.name) $($condition.oper) $($condition.value))"
                                        }
                                        $OutObj += [pscustomobject]@{
                                            "Condition"            = $conditions
                                            "Enforcement Profiles" = $rule.enforcement_profile_names -join ", "
                                        }
                                    }

                                    $TableParams = @{
                                        Name         = "Rules : $($policy.name)"
                                        List         = $false
                                        ColumnWidths = 70, 30
                                    }

                                    if ($Report.ShowTableCaptions) {
                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                    }

                                    $OutObj | Table @TableParams
                                }
                            }
                        }
                    }
                }

            }

            if ($enf_profile -and $InfoLevel.service -ge 1) {
                Section -Style Heading3 'Enforcement Profile' {
                    Paragraph "The following section details Enforcement Profile configured on ClearPass."
                    BlankLine

                    $OutObj = @()
                    foreach ($profile in $enf_profile) {
                        $OutObj += [pscustomobject]@{
                            "Id"          = $profile.id
                            "Name"        = $profile.name
                            "Type"        = $profile.type
                            "Description" = $profile.description
                            "Action"      = $profile.action
                            "Attribute"   = @($profile.attributes).count
                            "Ref"         = @($enf_policy | Where-Object { $_.rules.enforcement_profile_names -eq $profile.name }).count
                        }
                    }

                    $TableParams = @{
                        Name         = "Enforcement Profile"
                        List         = $false
                        ColumnWidths = 7, 30, 14, 25, 10, 7, 7
                    }

                    if ($Report.ShowTableCaptions) {
                        $TableParams['Caption'] = "- $($TableParams.Name)"
                    }

                    $OutObj | Table @TableParams

                    if ($InfoLevel.service -ge 2) {

                        Paragraph "The following section details Enforcement Profiles configured on ClearPass."
                        BlankLine
                        foreach ($profile in $enf_profile) {
                            Section -Style Heading3 "Enforcement Profiles: $($profile.name)" {
                                $OutObj = @()

                                $OutObj = [pscustomobject]@{
                                    "Id"   = $profile.id
                                    "Name" = $profile.name
                                    "Type" = $profile.type
                                }

                                #Action (not always available)
                                if ($profile.action) {
                                    $OutObj | Add-Member -MemberType NoteProperty -Name "Action" -Value $profile.action
                                }

                                if ($profile.radius_dyn_authz_template) {
                                    $OutObj | Add-Member -MemberType NoteProperty -Name "RADIUS Dyn Template" -Value $profile.radius_dyn_authz_template
                                }

                                $TableParams = @{
                                    Name         = "Enforcement profile: $($profile.name)"
                                    List         = $true
                                    ColumnWidths = 30, 70
                                }

                                if ($Report.ShowTableCaptions) {
                                    $TableParams['Caption'] = "- $($TableParams.Name)"
                                }

                                $OutObj | Table @TableParams

                                #Attributes
                                if ($profile.attributes) {
                                    $OutObj = @()
                                    foreach ($attributes in $profile.attributes) {

                                        $OutObj += [pscustomobject]@{
                                            "Type"  = $attributes.type
                                            "Name"  = $attributes.name
                                            "Value" = $attributes.value
                                        }
                                    }

                                    $TableParams = @{
                                        Name         = "Atttributes : $($profile.name)"
                                        List         = $false
                                        ColumnWidths = 25, 25, 50
                                    }

                                    if ($Report.ShowTableCaptions) {
                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                    }

                                    $OutObj | Table @TableParams
                                }

                                #TACACS Service Params
                                if ($profile.tacacs_service_params) {
                                    $OutObj = @()
                                    foreach ($tacacs_service_params in $profile.tacacs_service_params) {

                                        $OutObj += [pscustomobject]@{
                                            "Privilege Level"            = $tacacs_service_params.privilege_level
                                            "Services"                   = $tacacs_service_params.services -join ", "
                                            "Authorize Attribute Status" = $tacacs_service_params.authorize_attribute_status
                                        }
                                    }

                                    $TableParams = @{
                                        Name         = "Tacacs Services Params: $($profile.name)"
                                        List         = $false
                                        ColumnWidths = 33, 34, 33
                                    }

                                    if ($Report.ShowTableCaptions) {
                                        $TableParams['Caption'] = "- $($TableParams.Name)"
                                    }

                                    $OutObj | Table @TableParams
                                }
                            }
                        }
                    }
                }

            }
        }

    }

    end {

    }

}