Changing Header message on Begin section

vreguibar · Aug 7, 2024 · b6fc392 · b6fc392
1 parent 8a01044
commit b6fc392
Show file tree

Hide file tree

Showing 50 changed files with 644 additions and 412 deletions.
diff --git a/Enums/Enum.Constants.ps1 b/Enums/Enum.Constants.ps1
@@ -33,15 +33,39 @@
     # Message header for new regions. Used on NewCentralItOu to easily identify regions on transcript
     NewRegionMessage = @'
 
-    ################################################################################
-    #                                                                              #
-    #   ╔══════════════════════════════════════════════════════════════════════╗   #
-    #   ║                                                                      ║   #
-    #   ║                        New Region Start                              ║   #
-    #   ║                                                                      ║   #
-    #   ╚══════════════════════════════════════════════════════════════════════╝   #
-    #                                                                              #
-    ################################################################################
+    ████████████████████████████████████████████████████████████████████████████████████████████████████
+    █                                                                                                  █
+    █             ╔══════════════════════════════════════════════════════════════════════╗             █
+    █             ║                                                                      ║             █
+    █             ║                        New Region Start                              ║             █
+    █             ║                                                                      ║             █
+    █             ╚══════════════════════════════════════════════════════════════════════╝             █
+    █                                                                                                  █
+    ████████████████████████████████████████████████████████████████████████████████████████████████████
+
+        REGION: {0}
+
+'@
+
+    # Standard header used on each function on the Begin section
+    Header           = @'
+
+    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+    ┃                                        EguibarIT module                                           ┃
+    ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+            Date:     {0}
+            Starting: {1}
+
+    Parameters used by the function... {2}
+
+'@
+
+    # Standard footer used on each function on the Begin section
+    Footer           = @'
+
+    Function {0} finished {1}"
+
+    ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
 
 '@
 

diff --git a/Private/Get-ADCSTemplate.ps1 b/Private/Get-ADCSTemplate.ps1
@@ -44,10 +44,17 @@ Function Get-ADCSTemplate {
         $Server
     )
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         ##############################
         # Variables Definition

diff --git a/Private/Get-AdObjectType.ps1 b/Private/Get-AdObjectType.ps1
@@ -68,13 +68,17 @@
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
 
+        ##############################
+        # Module imports
 
-        Import-MyModule -name 'ActiveDirectory' -Verbose:$false
+        Import-Module -Name 'ActiveDirectory' -SkipEditionCheck -Force -Verbose:$false | Out-Null
 
 
         ##############################

diff --git a/Private/Get-CurrentErrorToDisplay.ps1 b/Private/Get-CurrentErrorToDisplay.ps1
@@ -38,10 +38,17 @@ function Get-CurrentErrorToDisplay {
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         ##############################
         # Variables Definition

diff --git a/Private/Get-IniContent.ps1 b/Private/Get-IniContent.ps1
@@ -1,5 +1,4 @@
-function Get-IniContent
-{
+function Get-IniContent {
   <#
       .Synopsis
       Gets the content of an INI file
@@ -54,15 +53,17 @@ function Get-IniContent
   [OutputType([System.Collections.Hashtable])]
   Param(
     [ValidateNotNullOrEmpty()]
-    [Parameter(ValueFromPipeline = $true,HelpMessage = 'Path and Filename to the ini file to be read',Mandatory = $true)]
+    [Parameter(ValueFromPipeline = $true, HelpMessage = 'Path and Filename to the ini file to be read', Mandatory = $true)]
     [string]$FilePath
   )
 
   Begin {
-    Write-Verbose -Message '|=> ************************************************************************ <=|'
-    Write-Verbose -Message (Get-Date).ToShortDateString()
-    Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-    Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+    $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+      $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+    )
+    Write-Verbose -Message $txt
 
     ##############################
     # Variables Definition
@@ -72,50 +73,45 @@ function Get-IniContent
     Write-Verbose -Message "$($myInvocation.MyCommand.Name):: Processing file: $PSBoundParameters['FilePath']"
 
     Try {
-    $ini = @{}
-    switch -regex -file $PSBoundParameters['FilePath']     {
-      '^\[(.+)\]$' # Section
-      {
-        $section = $matches[1]
-        $ini[$section] = @{}
-        $CommentCount = 0
-      }
-      '^(;.*)$' # Comment
-      {
-        if (!($section))
-        {
-          $section = 'No-Section'
+      $ini = @{}
+      switch -regex -file $PSBoundParameters['FilePath'] {
+        '^\[(.+)\]$' { # Section
+          $section = $matches[1]
           $ini[$section] = @{}
+          $CommentCount = 0
         }
-        $value = $matches[1]
-        $CommentCount = $CommentCount + 1
-        $name = 'Comment' + $CommentCount
-        $ini[$section][$name] = $value
-      }
-      '(.+?)\s*=\s*(.*)' # Key
-      {
-        if (!($section))
-        {
-          $section = 'No-Section'
-          $ini[$section] = @{}
+        '^(;.*)$' { # Comment
+          if (!($section)) {
+            $section = 'No-Section'
+            $ini[$section] = @{}
+          }
+          $value = $matches[1]
+          $CommentCount = $CommentCount + 1
+          $name = 'Comment' + $CommentCount
+          $ini[$section][$name] = $value
+        }
+        '(.+?)\s*=\s*(.*)' { # Key
+          if (!($section)) {
+            $section = 'No-Section'
+            $ini[$section] = @{}
+          }
+          $name, $value = $matches[1..2]
+          $ini[$section][$name] = $value
         }
-        $name, $value = $matches[1..2]
-        $ini[$section][$name] = $value
-      }
-    } #end Switch
-    } catch{
-        Write-Error -Message "An error occurred while processing the file: $_"
-        throw
+      } #end Switch
+    } catch {
+      Write-Error -Message "An error occurred while processing the file: $_"
+      throw
     } #end Try-Catch
     Write-Verbose -Message "$($myInvocation.MyCommand.Name):: Finished Processing file: $PSBoundParameters['FilePath']"
 
   } # End Process
 
-    End {
-        Write-Verbose -Message "Function $($MyInvocation.InvocationName) finished reading content from $PSBoundParameters['FilePath'] file."
-        Write-Verbose -Message ''
-        Write-Verbose -Message '-------------------------------------------------------------------------------'
-        Write-Verbose -Message ''
-        Return $ini
-    } #end End
+  End {
+    Write-Verbose -Message "Function $($MyInvocation.InvocationName) finished reading content from $PSBoundParameters['FilePath'] file."
+    Write-Verbose -Message ''
+    Write-Verbose -Message '-------------------------------------------------------------------------------'
+    Write-Verbose -Message ''
+    Return $ini
+  } #end End
 }
diff --git a/Private/Initialize-ModuleVariable.ps1 b/Private/Initialize-ModuleVariable.ps1
@@ -30,15 +30,20 @@
     Param ()
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message 'This function does not uses any Parameter.'
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
 
         ##############################
-        # Variables Definition
+        # Module imports
+
+        Import-Module ActiveDirectory -SkipEditionCheck -Force -Verbose:$false | Out-Null
 
-        Import-Module ActiveDirectory -Verbose:$false
+        ##############################
+        # Variables Definition
 
     } #end Begin
 

diff --git a/Private/New-Template.ps1 b/Private/New-Template.ps1
@@ -58,10 +58,17 @@ Function New-Template {
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         ##############################
         # Variables Definition

diff --git a/Private/New-TemplateOID.ps1 b/Private/New-TemplateOID.ps1
@@ -61,10 +61,17 @@ Function New-TemplateOID {
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         ##############################
         # Variables Definition

diff --git a/Private/Publish-CertificateTemplate.ps1 b/Private/Publish-CertificateTemplate.ps1
@@ -20,13 +20,21 @@ Function Publish-CertificateTemplate {
                 Eguibar Information Technology S.L.
                 http://www.eguibarit.com
         #>
-    [CmdletBinding(SupportsShouldProcess=$true)]
+    [CmdletBinding(SupportsShouldProcess = $true)]
     Param (
-        [Parameter(Mandatory=$true)]
+        [Parameter(Mandatory = $true)]
         [string]$CertDisplayName
     )
 
     begin {
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ######################
         # Initialize variables
         $Server = (Get-ADDomainController -Discover -ForceDiscover -Writable).HostName[0]
         $ConfigNC = (Get-ADRootDSE -Server $Server).configurationNamingContext
@@ -41,7 +49,7 @@ Function Publish-CertificateTemplate {
 
             if ($PSCmdlet.ShouldProcess("Certificate Template: $TemplateToAdd", "Publish to CA: $CAIdentity")) {
                 try {
-                    Set-ADObject -Identity $CAIdentity -Add @{certificateTemplates=$TemplateToAdd} -Server $Server -ErrorAction Stop
+                    Set-ADObject -Identity $CAIdentity -Add @{certificateTemplates = $TemplateToAdd } -Server $Server -ErrorAction Stop
                     Write-Verbose "Certificate template '$TemplateToAdd' published to CA: $CAIdentity"
                 } catch {
                     Write-Error "Failed to publish certificate template to CA: $CAIdentity. $_"

diff --git a/Private/Test-IsUniqueOID.ps1 b/Private/Test-IsUniqueOID.ps1
@@ -63,10 +63,17 @@ Function Test-IsUniqueOID {
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         ##############################
         # Variables Definition

diff --git a/Private/Test-IsValidDN.ps1 b/Private/Test-IsValidDN.ps1
@@ -43,10 +43,17 @@ function Test-IsValidDN {
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         # Initialize a boolean variable to store validation result
         [bool]$isValid = $false

diff --git a/Private/Test-IsValidGUID.ps1 b/Private/Test-IsValidGUID.ps1
@@ -45,10 +45,17 @@
     )
 
     Begin {
-        Write-Verbose -Message '|=> ************************************************************************ <=|'
-        Write-Verbose -Message (Get-Date).ToShortDateString()
-        Write-Verbose -Message ('  Starting: {0}' -f $MyInvocation.Mycommand)
-        Write-Verbose -Message ('Parameters used by the function... {0}' -f (Get-FunctionDisplay $PsBoundParameters -Verbose:$False))
+        $txt = ($constants.Header -f
+            (Get-Date).ToShortDateString(),
+            $MyInvocation.Mycommand,
+            (Get-FunctionDisplay $PsBoundParameters -Verbose:$False)
+        )
+        Write-Verbose -Message $txt
+
+        ##############################
+        # Module imports
+
+
 
         $isValid = $false