DLConversionV2

2.9.6.3

New-PowershellSession.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 <#
    .SYNOPSIS
 
    This function creates a powershell session to an on premises server to invoke winRM commands.
 
    .DESCRIPTION
 
    This function creates a powershell session to an on premises server to invoke winRM commands.
 
    .PARAMETER Credential
 
    This is the credential that will be utilized to establish the connection
 
    .PARAMETER Server
 
    This is the server that the connection will be made to.
 
    .PARAMETER PowershellSessionName
 
    This is the name of the powershell session that will be created.
 
    .PARAMETER connectionURI
 
    The web address for remote powershell sessions.
 
    .PARAMETER authenticationType
 
    Specifies to user kerberos or basic authentication is auth type is required.
 
    .PARAMETER configurationName
 
    The configuration name for the remote winRM sessions.
 
    .PARAMETER allowRedirection
 
    Determines if redirection is allowed on the winRM connection.
 
    .PARAMETER requiresImport
 
    Returns the PS session to the caller if import is required.
 
    .OUTPUTS
 
    Powershell session to use for aad connect commands.
 
    .EXAMPLE
 
    new-PowershellSession -Server SERVER -Credential Credential -PowershellSessionName Name
 
    #>
    Function New-PowershellSession
     {
        [cmdletbinding()]

        Param
        (
            [Parameter(ParameterSetName="NotOnline",Mandatory = $true)]
            [Parameter(ParameterSetName="Online",Mandatory = $true)]
            [pscredential]$Credentials,
            [Parameter(ParameterSetName="NotOnline",Mandatory = $true)]
            [string]$Server,
            [Parameter(ParameterSetName="NotOnline",Mandatory = $true)]
            [Parameter(ParameterSetName="Online",Mandatory = $true)]
            [string]$PowershellSessionName,
            [Parameter(ParameterSetName="Online",Mandatory = $true)]
            [string]$connectionURI,
            [Parameter(ParameterSetName="Online",Mandatory = $true)]
            [Parameter(ParameterSetName="NotOnline",Mandatory = $true)]
            [string]$authenticationType,
            [Parameter(ParameterSetName="Online",Mandatory = $true)]
            [string]$configurationName,
            [Parameter(ParameterSetName="Online")]
            [boolean]$allowRedirection=$FALSE,
            [Parameter(ParameterSetName="Online")]
            [boolean]$requiresImport=$FALSE,
            [Parameter(ParameterSetName="NotOnline",Mandatory = $false)]
            [Parameter(ParameterSetName="Online",Mandatory = $false)]
            [boolean]$isAudit=$FALSE
        )

        #Output all parameters bound or unbound and their associated values.

        write-functionParameters -keyArray $MyInvocation.MyCommand.Parameters.Keys -parameterArray $PSBoundParameters -variableArray (Get-Variable -Scope Local -ErrorAction Ignore)

        #Declare function variables.

        $sessionToImport=$NULL

        #Start function processing.

        Out-LogFile -string "********************************************************************************"
        Out-LogFile -string "BEGIN NEW-POWERSHELLSESSION"
        Out-LogFile -string "********************************************************************************"
        
        try 
        {
            if ($requiresImport -eq $FALSE)
            {
                #The session was flagged by the caller as requiring import.
                #This would usually be reserved for things like Exchange On Premises / Exchange Online

                Out-LogFile -string "Creating the powershell to server." 
                New-PSSession -computername $Server -credential $Credentials -name $PowershellSessionName -authentication $authenticationType -errorAction STOP
            }
            elseif ($requiresImport -eq $TRUE)
            {
                #No import is required - this is a local powershell session

                Out-LogFile -string "Creating the powershell to server that requires import." 
                $sessiontoimport=New-PSSession -ConfigurationName $configurationName -ConnectionUri $connectionURI -Credential $credentials -AllowRedirection:$allowRedirection -Authentication $authenticationType -name $PowershellSessionName 
            }
        }
        catch 
        {
            Out-LogFile -string $_ -isError:$TRUE -isAudit $isAudit
        }

        Out-LogFile -string "The powershell session was created successfully."

        Out-LogFile -string "END NEW-POWERSHELLSESSION"
        Out-LogFile -string "********************************************************************************"
    
        #This function is designed to open local and remote powershell sessions.
        #If the session requires import - for example exchange - return the session for later work.
        #If not no return is required.
        
        if ($requiresImport -eq $TRUE)
        {
            return $sessionToImport
        }  
    }