PPoShTools

1.0.17

Public/Utils/New-PSSessionCustom.ps1

function New-PSSessionCustom {
    <#
    .SYNOPSIS
    Creates PS Session object depends on parameters passed

    .DESCRIPTION
    Accepts ComputerName, Credentials and ConfigurationName as parameters to create PS Session. If no credentials are given, current credentials are used.

    .PARAMETER ComputerName
    Computer name of the nodes where the PS Session will be established.

    .PARAMETER Credential
    A PSCredential object that will be used when opening a remoting session to any of the $Nodes specified.

    .PARAMETER ConfigurationName
    PowerShell Configuration name to use (JEA).

    .EXAMPLE
    New-PSSessionCustom -ComputerName 'SomeServer' -Credential (Get-Credential)
    Will use {SomeDomain\SomeUser} to create PSSession to computer {SomeServer}
    Created PSSession to computer {SomeServer}
    ```
    Id Name ComputerName ComputerType State ConfigurationName Availability
    -- ---- ------------ ------------ ----- ----------------- ------------
    5 WinRM5 SomeServer RemoteMachine Opened Microsoft.PowerShell Available
    ```

    .OUTPUTS
    Will output PSSession object
    #>

    [CmdletBinding()]
    [OutputType([System.Management.Automation.Runspaces.PSSession])]
    param(
        [Parameter(Mandatory=$true,
            ValueFromPipeline,ValueFromPipelineByPropertyName)]
        [string]
        $ComputerName,

        [Parameter(Mandatory=$false,
            ValueFromPipeline,ValueFromPipelineByPropertyName)]
        [System.Management.Automation.PSCredential]
        $Credential,

        [Parameter(Mandatory=$false,
            ValueFromPipeline,ValueFromPipelineByPropertyName)]
        [string]
         $ConfigurationName
    )
    process {
    $sessionParams = @{
        ComputerName = $ComputerName
      }
    if($PSBoundParameters.ContainsKey('ConfigurationName')){
        $sessionParams.ConfigurationName = $ConfigurationName
    }
      if($PSBoundParameters.ContainsKey('Credential')){
        $sessionParams.Credential = $Credential
        Write-Log -Info -Message "Will use {$($Credential.UserName)} to create PSSession to computer {$($sessionParams.ComputerName)}"
      }
      else{
        Write-Log -Info -Message "Will use current user Credential {$($ENV:USERNAME)} to create PSSession to computer {$($sessionParams.ComputerName)}"
      }
      $Session = New-PSSession @sessionParams -ErrorAction SilentlyContinue
      if ($Session) {
        Write-Log -Info -Message "Created PSSession to computer {$($Session.ComputerName)}"
      }
      else {
        Write-Log -Error -Message "Unable to create PSSession to computer {$($Session.ComputerName)}. Aborting!"
        break
      }
      $Session
    }
}