Compare commits
21 Commits
v1.1.0-dev
...
471a372bf9
Author | SHA1 | Date | |
---|---|---|---|
471a372bf9 | |||
e3349cc4dd | |||
2399f227c9 | |||
1747bb24a8 | |||
c125ad0acd | |||
2a51e76b07 | |||
13351d7e2e | |||
3105a3230a | |||
9ed86fd126 | |||
4c9c03d7da | |||
22631f2836 | |||
a5b430e4ae | |||
c272b30cb4 | |||
b7ad5663dc | |||
9de752691b | |||
f27f1faad7 | |||
56727afa3e | |||
79a1a214c2 | |||
ddb85d907f | |||
5bdb383627 | |||
a95ba31e40 |
26
CHANGELOG.md
Normal file
26
CHANGELOG.md
Normal file
@ -0,0 +1,26 @@
|
||||
# Changelog
|
||||
|
||||
<!-- insertMark -->
|
||||
## `v1.1.0`
|
||||
|
||||
- (acb09ba) update Changelog
|
||||
- (5bdb383) updates Readme (#69)
|
||||
- (a95ba31) remove optional depenency helper (#68)
|
||||
- (1e7dd78) adds CiscoUCSCentral connection type (#67)
|
||||
- (b76668c) fix Test-CredentialStoreItem return (#66)
|
||||
- (ae62ccc) switch to GNU AGPLv3 license (#64)
|
||||
- (a66e824) adds community contribution for CiscoUCS connection fix (#63)
|
||||
- (3d90d91) fix lint (PSScriptAnalyzer) issues (#62)
|
||||
- (d0b7e53) adds DroneHelper (#61)
|
||||
- (d4b00a5) Migrates to Pester5+ tests (#59)
|
||||
- (e340466) update references (#60)
|
||||
- (88743e9) fix pester verbosity config (#58)
|
||||
- (c31ee79) Update issue templates (#57)
|
||||
- (c45490a) Update issue templates (#56)
|
||||
- (4abfec5) adds PR template (#55)
|
||||
- (7708df9) Update pwsh style to latest community standards (#52)
|
||||
|
||||
|
||||
## `v1.0.542`
|
||||
|
||||
- 🧙 pre migrated Gitea version
|
65
README.md
65
README.md
@ -5,7 +5,10 @@
|
||||
|
||||
<p align="center">
|
||||
<a href="https://gitea.ocram85.com/OCram85/PSCredentialStore/">
|
||||
<img src="https://gitea.ocram85.com/OCram85/PSCredentialStore/raw/branch/master/assets/social-logo.png" alt="PSCredentialStore" />
|
||||
<img
|
||||
src="https://gitea.ocram85.com/OCram85/PSCredentialStore/raw/branch/master/assets/social-logo.png"
|
||||
alt="PSCredentialStore"
|
||||
>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -19,7 +22,10 @@
|
||||
|
||||
<p align="center">
|
||||
<a href="https://drone.ocram85.com/OCram85/PSCredentialStore">
|
||||
<img src="https://drone.ocram85.com/api/badges/OCram85/PSCredentialStore/status.svg" alt="Master Branch Build Status">
|
||||
<img
|
||||
src="https://drone.ocram85.com/api/badges/OCram85/PSCredentialStore/status.svg"
|
||||
alt="Master Branch Build Status"
|
||||
>
|
||||
</a>
|
||||
<!-- CodeCove disabled for self hosting git
|
||||
<a href="https://codecov.io/gh/OCram85/PSCredentialStore">
|
||||
@ -27,23 +33,30 @@
|
||||
</a>
|
||||
-->
|
||||
<a href="https://www.powershellgallery.com/packages/PSCredentialStore">
|
||||
<img src="https://img.shields.io/powershellgallery/v/PSCredentialStore.svg?style=plastic" alt="PowershellGallery Published Version">
|
||||
<img
|
||||
src="https://img.shields.io/powershellgallery/v/PSCredentialStore.svg?style=plastic"
|
||||
alt="PowershellGallery Published Version"
|
||||
>
|
||||
</a>
|
||||
<a href="https://www.powershellgallery.com/packages/PSCredentialStore">
|
||||
<img src="https://img.shields.io/powershellgallery/vpre/PSCredentialStore.svg?label=latest%20preview&style=plastic" />
|
||||
<img
|
||||
src="https://img.shields.io/powershellgallery/vpre/PSCredentialStore.svg?label=latest%20preview&style=plastic"
|
||||
>
|
||||
</a>
|
||||
<a href="https://www.powershellgallery.com/packages/PSCredentialStore">
|
||||
<img src="https://img.shields.io/powershellgallery/dt/PSCredentialStore.svg?style=plastic" />
|
||||
<img
|
||||
src="https://img.shields.io/powershellgallery/dt/PSCredentialStore.svg?style=plastic"
|
||||
>
|
||||
</a>
|
||||
</p>
|
||||
|
||||
|
||||
## :key: General
|
||||
|
||||
The PSCredentialStore is a simple credential manager for `PSCredential` objects. It stores PSCredentials in a simple json
|
||||
file. You can choose between a private and shared credential store. The private one exists in your profile and can
|
||||
ony accessed by your account on the same machine. The shared store enables you to use different credentials for your
|
||||
scripts without exposing them as plain text.
|
||||
The PSCredentialStore is a simple credential manager for `PSCredential` objects. It stores PSCredentials in a simple
|
||||
json file. You can choose between a private and shared credential store. The private one exists in your profile and
|
||||
can ony accessed by your account on the same machine. The shared store enables you to use different credentials for
|
||||
your scripts without exposing them as plain text.
|
||||
|
||||
PSCredentialStore was developed to simplify the delegation of complex powershell scripts. In this case you often
|
||||
need to store credentials for non interactive usage like in scheduled tasks.
|
||||
@ -51,10 +64,10 @@ need to store credentials for non interactive usage like in scheduled tasks.
|
||||
Starting with version `1.0.0` PSCredential uses Pfx certificates fo encryption. You can use Pfx certificate files
|
||||
or certificates stored in the certificate store.
|
||||
|
||||
For more details read the [about_PSCredentialStore](/docs/about_PSCredentialStore.md) page on gitea or via CLI with
|
||||
For more details read the [about_PSCredentialStore](docs/about_PSCredentialStore.md) page on Gitea or via CLI with
|
||||
`Get-Help about_PSCredentialStore`.
|
||||
|
||||
You can find the [reference](/docs/PSCredentialStore.md) in the /docs/ path as well.
|
||||
You can find the full [reference](docs/Readme.md) in the */docs/* path as well.
|
||||
|
||||
## :vulcan_salute: Requirements
|
||||
|
||||
@ -63,24 +76,26 @@ You can find the [reference](/docs/PSCredentialStore.md) in the /docs/ path as w
|
||||
|
||||
## :bomb: About Security
|
||||
|
||||
>This section explains some security topics and the the design decisions we made to balance the usage and security needs.
|
||||
> This section explains some security topics and the design decisions we made to balance the usage and security needs.
|
||||
|
||||
To be able to delegate `PSCredentials` objects we can't exclusively rely on the `SecureString` cmdlets. You can't
|
||||
decrypt and reuse such credentials from a different user account or even machine. This is caused by automatically
|
||||
generated encryption key which, is used create a `Secure String` based encrypted string.
|
||||
generated encryption key, which is used create a `Secure String` based encrypted string.
|
||||
|
||||
In order to delegate a password, while still using the underlying security framework, we have to provide a custom
|
||||
encryption key. This leads to the fact, that everyone who has access to the key could encrypt or decrypt your data.
|
||||
|
||||
So we decided to use the public and private keys from valid certificates as part of the custom encryption keys to encrypt your data.
|
||||
So we decided to use the public and private keys from valid certificates as part of the custom encryption keys to
|
||||
encrypt your data.
|
||||
|
||||
This means clearly: Everyone who has access to the `CredentialStore` needs also access to the certificate file to work with it.
|
||||
This means clearly: Everyone who has access to the `CredentialStore` needs also access to the certificate file to
|
||||
work with it.
|
||||
|
||||
Keep in mind you need to secure the access with your NTFS file permissions to avoid unwanted usage. Another option is
|
||||
to import the certificate into your certification vaults of you operating system. In this case you can grand the
|
||||
Keep in mind you need to secure the access with your NTFS file permissions to avoid unwanted usage. Another option
|
||||
is to import the certificate into your certification vaults of you operating system. In this case you can grand the
|
||||
permission to the certificates itself.
|
||||
|
||||
Here is s brief hierarchy description of the certificate location: *(First match wins)*
|
||||
Here is a brief hierarchy description for the certificate lookup order: *(First match wins)*
|
||||
|
||||
| CredentialStore Type | Certificate Location |
|
||||
| -------------------- | ---------------------- |
|
||||
@ -95,9 +110,9 @@ Here is s brief hierarchy description of the certificate location: *(First match
|
||||
### :artificial_satellite: PowerShellGallery.com (Recommended Way)
|
||||
|
||||
* Make sure you use PowerShell 5.1 or higher with `$PSVersionTable`.
|
||||
* Use the builtin PackageManagement and install with: `Import-Module PowerShellGet; Install-Module 'PSCredentialStore' -Repository 'PSGallery'`
|
||||
* Use the builtin PackageManagement + PowerShellGet module and install PSCredentialStore with: `Import-Module PowerShellGet; Install-Module 'PSCredentialStore' -Repository 'PSGallery'`
|
||||
* Additionally use the `-AllowPrerelease` switch until we publish the final release!
|
||||
* Done. Start exploring the Module with `Import-Module PSCredentialStore ; Get-Command -Module PSCredentialStore`
|
||||
* Done. Start exploring the Module with `Import-Module PSCredentialStore; Get-Command -Module PSCredentialStore`
|
||||
|
||||
### :building_construction: Manual Way
|
||||
|
||||
@ -109,8 +124,9 @@ Here is s brief hierarchy description of the certificate location: *(First match
|
||||
|
||||
### :sparkles: Quick Start
|
||||
|
||||
**1.** First we need a blank credential store. You can decide between a *private* or *shared* store. The private
|
||||
Credential Store can only be accessed with your profile on the machine you created it.
|
||||
**1.** First we need a blank credential store. You can decide between a *private* or *shared* one.
|
||||
|
||||
> :bulb: Note: The private credential store can only be accessed with your profile on the machine you created it.
|
||||
|
||||
Starting with version `1.0.0` you can decide the storage type of your fresh created certificate. As default
|
||||
PSCredentialStore creates a new pfx certificate file beside the credential store itself. Optionally you can provide
|
||||
@ -126,11 +142,12 @@ New-CredentialStore -UseCertStore
|
||||
# Shared credential store
|
||||
New-CredentialStore -Shared
|
||||
|
||||
#Shared credential store in custom location
|
||||
# Shared credential store in custom location
|
||||
New-CredentialStore -Shared -Path 'C:\CredentialStore.json'
|
||||
```
|
||||
|
||||
**2.** Now you can manage your credential store items:
|
||||
|
||||
```powershell
|
||||
# This will prompt for credentials and stores it in a private store
|
||||
New-CredentialStoreItem -RemoteHost 'dc01.myside.local' -Identifier 'AD'
|
||||
@ -141,7 +158,7 @@ Invoke-Command -ComputerName 'dc01.myside.local' -Credential $DCCreds -ScripBloc
|
||||
```
|
||||
|
||||
The credential store contains also a simple function to establish a connection with several systems or protocols.
|
||||
If you have already installed the underlying framework / modules, you can connect these endpoints:
|
||||
If you have already installed the underlying framework / modules, you can connect to these endpoint types:
|
||||
|
||||
* **CiscoUcs** - Establish a connection to a Cisco UCS fabric interconnect.
|
||||
* Required Modules: [`Cisco.UCS.Core`, `Cisco.UCSManager`](https://software.cisco.com/download/release.html?i=!y&mdfid=286305108&softwareid=284574017&release=2.1.1)
|
||||
|
@ -1,38 +0,0 @@
|
||||
{
|
||||
"Version": 0.1,
|
||||
"Mandatory": {},
|
||||
"Optional": [
|
||||
{
|
||||
"Name": "foobar2000",
|
||||
"Modules": [
|
||||
"foobar2000"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Name": "foo",
|
||||
"Modules": [
|
||||
"foo",
|
||||
"bar"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Name": "bar",
|
||||
"Modules": [
|
||||
"bar"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Name": "Existing",
|
||||
"Modules": [
|
||||
"PowerShellGet"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Name": "PSGetMixed",
|
||||
"Modules": [
|
||||
"PowerShellGet",
|
||||
"foobar2000"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
@ -10,7 +10,7 @@ function Connect-To {
|
||||
Specify the host, for which you would like to change the credentials.
|
||||
|
||||
.PARAMETER Identifier
|
||||
Defaults to "". Specify a string, which separates two CredentialStoreItems for the
|
||||
Defaults to ''. Specify a string, which separates two CredentialStoreItems for the
|
||||
same hostname.
|
||||
|
||||
.PARAMETER Type
|
||||
@ -18,13 +18,14 @@ function Connect-To {
|
||||
|
||||
- CiscoUcs
|
||||
- CiscoUcsCentral
|
||||
- CisServer
|
||||
- ExchangeHTTP
|
||||
- ExchangeHTTPS
|
||||
- FTP
|
||||
- NetAppFAS
|
||||
- NetAppStorageGRID
|
||||
- SCP
|
||||
- VMware
|
||||
- VMwareCisServer
|
||||
|
||||
.PARAMETER Credentials
|
||||
Use this parameter to bypass the stored credentials. Without this parameter Connect-To tries to read the
|
||||
@ -48,79 +49,86 @@ function Connect-To {
|
||||
[None]
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "ucs.myside.local" -Type CiscoUcs
|
||||
Connect-To -RemoteHost 'vc.domain.local' -Type CisServer
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "ucscentral.myside.local" -Type 'CiscoUcsCentral'
|
||||
Connect-To -RemoteHost 'ucs.domain.local' -Type CiscoUcs
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "ftp.myside.local" -Type FTP
|
||||
Connect-To -RemoteHost 'ucs-central.domain.local' -Type 'CiscoUcsCentral'
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "fas.myside.local" -Type NetAppFAS
|
||||
Connect-To -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTP
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "esx01.myside.local" -Type VMware
|
||||
Connect-To -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTPS
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "vCenter.myside.local" -Type CisServer
|
||||
Connect-To -RemoteHost 'ftp.domain.local' -Type FTP
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
|
||||
Connect-To -RemoteHost 'fas.domain.local' -Type NetAppFAS
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
||||
Connect-To -RemoteHost 'grid.domain.local' -Type NetAppStorageGRID
|
||||
|
||||
.EXAMPLE
|
||||
Connect-To -RemoteHost 'esx01.domain.local' -Type VMware
|
||||
|
||||
#>
|
||||
|
||||
[CmdletBinding(DefaultParameterSetName = 'Private')]
|
||||
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
|
||||
'PSAvoidGlobalVars',
|
||||
'',
|
||||
Justification = 'Wrapping existing var from WinSCP module.'
|
||||
)]
|
||||
|
||||
param (
|
||||
[Parameter(Mandatory = $true, ParameterSetName = 'Shared')]
|
||||
[Parameter(Mandatory = $true, ParameterSetName = 'Private')]
|
||||
[string]$RemoteHost,
|
||||
[string] $RemoteHost,
|
||||
|
||||
[Parameter(Mandatory = $false, ParameterSetName = 'Shared')]
|
||||
[Parameter(Mandatory = $false, ParameterSetName = 'Private')]
|
||||
[string]$Identifier,
|
||||
[string] $Identifier,
|
||||
|
||||
[Parameter(Mandatory = $true, ParameterSetName = 'Shared')]
|
||||
[Parameter(Mandatory = $true, ParameterSetName = 'Private')]
|
||||
[ValidateSet(
|
||||
'CiscoUcs',
|
||||
'CiscoUcsCentral',
|
||||
'FTP',
|
||||
'NetAppFAS',
|
||||
'VMware',
|
||||
'CisServer',
|
||||
'ExchangeHTTP',
|
||||
'ExchangeHTTPS',
|
||||
'SCP'
|
||||
'FTP',
|
||||
'NetAppFAS',
|
||||
'NetAppStorageGRID',
|
||||
'SCP',
|
||||
'VMware',
|
||||
'VMwareCisServer'
|
||||
)]
|
||||
[string]$Type,
|
||||
[string] $Type,
|
||||
|
||||
[Parameter(Mandatory = $False, ParameterSetName = 'Shared')]
|
||||
[Parameter(Mandatory = $False, ParameterSetName = 'Private')]
|
||||
[PSCredential]$Credentials,
|
||||
[PSCredential] $Credentials,
|
||||
|
||||
[Parameter(Mandatory = $true, ParameterSetNAme = 'Shared')]
|
||||
[switch]$Shared,
|
||||
[switch] $Shared,
|
||||
|
||||
[Parameter(Mandatory = $False, ParameterSetName = 'Shared')]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string]$Path,
|
||||
[string] $Path,
|
||||
|
||||
[Parameter(Mandatory = $False, ParameterSetName = 'Private')]
|
||||
[Parameter(Mandatory = $False, ParameterSetName = 'Shared')]
|
||||
[switch]$PassThru
|
||||
[switch] $PassThru
|
||||
)
|
||||
|
||||
begin {
|
||||
# Set the CredentialStore for private, shared or custom mode.
|
||||
Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName)
|
||||
Write-Debug ('ParameterSetName: {0}' -f $PSCmdlet.ParameterSetName)
|
||||
if ($PSCmdlet.ParameterSetName -eq 'Private') {
|
||||
$Path = Get-DefaultCredentialStorePath
|
||||
}
|
||||
@ -130,14 +138,8 @@ function Connect-To {
|
||||
}
|
||||
}
|
||||
|
||||
# First check the optional modules
|
||||
if (-not (Resolve-Dependency -Name $Type)) {
|
||||
Write-Error -Message (
|
||||
"Could not resolve the optional dependencies defined for {0}" -f $Type
|
||||
) -ErrorAction 'Stop'
|
||||
}
|
||||
switch ($Type) {
|
||||
"VMware" {
|
||||
'VMware' {
|
||||
# Disable the yellow certificate warning, since we haven't replaced the SSL certs for vCenter/ESXi
|
||||
$null = Set-PowerCLIConfiguration -Scope Session -InvalidCertificateAction Ignore -Confirm:$false
|
||||
|
||||
@ -145,6 +147,11 @@ function Connect-To {
|
||||
$null = Set-PowerCLIConfiguration -Scope Session -ProxyPolicy NoProxy -Confirm:$false
|
||||
}
|
||||
}
|
||||
|
||||
# Set sane defaults for Progress, ErrorAction and InformationPreference
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$InformationPreference = 'Continue'
|
||||
}
|
||||
|
||||
process {
|
||||
@ -155,8 +162,8 @@ function Connect-To {
|
||||
# Check if $Identifier has been defined, in which case we need to use different name for
|
||||
# the lookup of the CredentialStoreItem.
|
||||
try {
|
||||
if ($Identifier -ne "") {
|
||||
$RemoteHostIdentifier = "{0}/{1}" -f $Identifier, $RemoteHost
|
||||
if ($Identifier -ne '') {
|
||||
$RemoteHostIdentifier = '{0}/{1}' -f $Identifier, $RemoteHost
|
||||
$creds = Get-CredentialStoreItem -Shared -RemoteHost $RemoteHostIdentifier -Path $Path
|
||||
}
|
||||
else {
|
||||
@ -167,8 +174,8 @@ function Connect-To {
|
||||
catch {
|
||||
$MessageParams = @{
|
||||
Message = (
|
||||
"Unable to look up credential store item for RemoteHost " +
|
||||
("{0}/Identifier {1}!" -f $RemoteHost, $Identifier)
|
||||
'Unable to look up credential store item for RemoteHost ' +
|
||||
('{0}/Identifier {1}!' -f $RemoteHost, $Identifier)
|
||||
)
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
@ -179,44 +186,70 @@ function Connect-To {
|
||||
$creds = $Credentials
|
||||
}
|
||||
|
||||
if ($creds.UserName -eq "" -or $creds.Password.GetType().Name -ne 'SecureString') {
|
||||
if ($creds.UserName -eq '' -or $creds.Password.GetType().Name -ne 'SecureString') {
|
||||
$MessageParams = @{
|
||||
Message = "Please provide valid credentials for RemoteHost {0}!" -f $RemoteHost
|
||||
Message = 'Please provide valid credentials for RemoteHost {0}!' -f $RemoteHost
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
else {
|
||||
switch ($Type) {
|
||||
"CiscoUcs" {
|
||||
'CiscoUcs' {
|
||||
try {
|
||||
$handle = Connect-Ucs -Name $RemoteHost -Credential $creds -ErrorAction 'Stop' -NotDefault
|
||||
$handle = Connect-Ucs -Name $RemoteHost -Credential $creds -NotDefault
|
||||
$ExecutionContext.SessionState.PSVariable.Set('DefaultUcs', $handle)
|
||||
}
|
||||
|
||||
catch {
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
"CiscoUcsCentral" {
|
||||
|
||||
'CiscoUcsCentral' {
|
||||
try {
|
||||
$handle = Connect-UcsCentral -Name $RemoteHost -Credential $creds -NotDefault
|
||||
$ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $handle)
|
||||
}
|
||||
|
||||
catch {
|
||||
$MessageParams = @{
|
||||
Message = ('Unable to connect to {0} using {1}' -f $RemoteHost, $Type)
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to connect to {0} using {1}' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
"FTP" {
|
||||
|
||||
'ExchangeHTTP' {
|
||||
try {
|
||||
$ConnectionParams = @{
|
||||
ConnectionURI = 'http://{0}/powershell' -f $RemoteHost
|
||||
ConfigurationName = 'Microsoft.Exchange'
|
||||
Credential = $creds
|
||||
}
|
||||
$global:PSExchangeRemote = New-PSSession @ConnectionParams
|
||||
# ScriptAnalyzer issue (unused var) workaround.
|
||||
$null = $global:PSExchangeRemote
|
||||
}
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
'ExchangeHTTPS' {
|
||||
try {
|
||||
$ConnectionParams = @{
|
||||
ConnectionURI = 'https://{0}/powershell' -f $RemoteHost
|
||||
ConfigurationName = 'Microsoft.Exchange'
|
||||
Credential = $creds
|
||||
}
|
||||
$global:PSExchangeRemote = New-PSSession @ConnectionParams
|
||||
}
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
'FTP' {
|
||||
# First establish the FTP session
|
||||
$WinSCPConParams = @{
|
||||
Credential = $creds
|
||||
@ -224,115 +257,81 @@ function Connect-To {
|
||||
Protocol = 'Ftp'
|
||||
FtpMode = 'Passive'
|
||||
}
|
||||
|
||||
try {
|
||||
$FTPSessionOption = New-WinSCPSessionOption @WinSCPConParams
|
||||
$Global:WinSCPSession = New-WinSCPSession -SessionOption $FTPSessionOption
|
||||
$global:WinSCPSession = New-WinSCPSession -SessionOption $FTPSessionOption
|
||||
}
|
||||
catch {
|
||||
throw "Could not connect to {0} using {1} protocol!" -f $RemoteHost, $Type
|
||||
Write-Error -Message ('Could not connect to {0} using {1} protocol!' -f $RemoteHost, $Type)
|
||||
}
|
||||
|
||||
# Check the Connection State
|
||||
if (!($WinSCPSession.Opened)) {
|
||||
if (-not $WinSCPSession.Opened) {
|
||||
# Check the connection state and find out if the session is still open.
|
||||
$MessageParams = @{
|
||||
Message = (
|
||||
("Connection to {0} using Type {1} " -f $RemoteHost, $Type) +
|
||||
"was established. But now it seems to be lost!"
|
||||
)
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
$m = 'Connection to {0} using Type {1} was established. ' -f $RemoteHost, $Type
|
||||
$m += 'But now it seems to be lost!'
|
||||
Write-Error -Message $m
|
||||
}
|
||||
}
|
||||
"NetAppFAS" {
|
||||
|
||||
'NetAppFAS' {
|
||||
# Construct the splatting for Connect-NcController
|
||||
$params = @{
|
||||
Name = $RemoteHost
|
||||
Credential = $creds
|
||||
HTTPS = $true
|
||||
}
|
||||
|
||||
# Check if -PassThru was passed. If so, a) do not set the default variable and b) return the
|
||||
# session object to the caller.
|
||||
if ($PSBoundParameters.ContainsKey('PassThru')) {
|
||||
$params.Add('Transient', $true)
|
||||
}
|
||||
|
||||
try {
|
||||
$null = Connect-NcController -Name $RemoteHost -Credential $creds -ErrorAction Stop -HTTPS
|
||||
$handle = Connect-NcController @params
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
|
||||
if ($PSBoundParameters.ContainsKey('PassThru')) {
|
||||
return $handle
|
||||
}
|
||||
}
|
||||
"VMware" {
|
||||
|
||||
'NetAppStorageGRID' {
|
||||
# Construct the splatting for Connect-SgwServer
|
||||
$params = @{
|
||||
Name = $RemoteHost
|
||||
Credential = $creds
|
||||
SkipCertificateCheck = $true
|
||||
}
|
||||
|
||||
# Check if -PassThru was passed. If so, a) do not set the default variable and b) return the
|
||||
# session object to the caller.
|
||||
if ($PSBoundParameters.ContainsKey('PassThru')) {
|
||||
$params.Add('Transient', $true)
|
||||
}
|
||||
|
||||
try {
|
||||
Connect-VIServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
|
||||
$SgwSession = Connect-SgwServer @params
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
}
|
||||
"CisServer" {
|
||||
try {
|
||||
if ($PassThru.IsPresent) {
|
||||
Connect-CisServer -Server $RemoteHost -Credential $creds -ErrorAction Stop
|
||||
}
|
||||
else {
|
||||
Connect-CisServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
|
||||
}
|
||||
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
if ($PSBoundParameters.ContainsKey('PassThru')) {
|
||||
return $SgwSession
|
||||
}
|
||||
}
|
||||
"ExchangeHTTP" {
|
||||
try {
|
||||
$ConnectionParams = @{
|
||||
ConnectionURI = "http://{0}/powershell" -f $RemoteHost
|
||||
ConfigurationName = 'Microsoft.Exchange'
|
||||
Credential = $creds
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
$Global:PSExchangeRemote = New-PSSession @ConnectionParams
|
||||
# ScriptAnalyzer issue (unused var) workaround.
|
||||
$null = $Global:PSExchangeRemote
|
||||
}
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
}
|
||||
"ExchangeHTTPS" {
|
||||
try {
|
||||
$ConnectionParams = @{
|
||||
ConnectionURI = "https://{0}/powershell" -f $RemoteHost
|
||||
ConfigurationName = 'Microsoft.Exchange'
|
||||
Credential = $creds
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
$Global:PSExchangeRemote = New-PSSession @ConnectionParams
|
||||
}
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
}
|
||||
"SCP" {
|
||||
|
||||
'SCP' {
|
||||
$WinSCPSessionParams = @{
|
||||
Credential = $creds
|
||||
Hostname = $RemoteHost
|
||||
@ -341,39 +340,49 @@ function Connect-To {
|
||||
}
|
||||
try {
|
||||
$SessionOption = New-WinSCPSessionOption @WinSCPSessionParams
|
||||
$Global:WinSCPSession = New-WinSCPSession -SessionOption $SessionOption
|
||||
$global:WinSCPSession = New-WinSCPSession -SessionOption $SessionOption
|
||||
Write-Verbose -Message (
|
||||
"SCP Connection established with {0}" -f $Global:WinSCPSession.Hostname
|
||||
'SCP Connection established with {0}' -f $global:WinSCPSession.Hostname
|
||||
)
|
||||
}
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
# Check the Connection State
|
||||
if (!($WinSCPSession.Opened)) {
|
||||
# Check the connection state and find out if the session is still open.
|
||||
$MessageParams = @{
|
||||
Message = (
|
||||
("Connection to {0} using Type {1} was established. " -f $RemoteHost, $Type) +
|
||||
"But now it seems to be lost!"
|
||||
)
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
$m = 'Connection to {0} using Type {1} was established. ' -f $RemoteHost, $Type
|
||||
$m += 'But now it seems to be lost!'
|
||||
Write-Error -Message $m
|
||||
}
|
||||
}
|
||||
default {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to connect to {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
|
||||
'VMware' {
|
||||
try {
|
||||
Connect-VIServer -Server $RemoteHost -Credential $creds -ErrorAction Stop | Out-Null
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
'VMwareCisServer' {
|
||||
try {
|
||||
if ($PassThru.IsPresent) {
|
||||
Connect-CisServer -Server $RemoteHost -Credential $creds
|
||||
}
|
||||
else {
|
||||
$null = Connect-CisServer -Server $RemoteHost -Credential $creds
|
||||
}
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
Write-Error -Message ('Unable to connect to {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1,30 +1,26 @@
|
||||
function Disconnect-From {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Terminates a session established with Connect-To using a CredentialStoreItem.
|
||||
Terminates a session established with Connect-To.
|
||||
|
||||
.DESCRIPTION
|
||||
Terminates a session established with Connect-To using a CredentialStoreItem.
|
||||
Terminates a session established with Connect-To.
|
||||
|
||||
.PARAMETER RemoteHost
|
||||
Specify the remote endpoint, whose session you would like to terminate.
|
||||
|
||||
.PARAMETER Identifier
|
||||
Defaults to "". Specify a string, which separates two CredentialStoreItems for the
|
||||
same hostname.
|
||||
|
||||
.PARAMETER Type
|
||||
Specify the host type of the target. Currently implemented targets are:
|
||||
|
||||
- CiscoUcs
|
||||
- CiscoUcsCentral
|
||||
- FTP
|
||||
- NetAppFAS
|
||||
- VMware
|
||||
- CisServer
|
||||
- ExchangeHTTP
|
||||
- ExchangeHTTPS
|
||||
- FTP
|
||||
- NetAppFAS
|
||||
- NetAppStorageGRID
|
||||
- SCP
|
||||
- VMware
|
||||
- VMwareCisServer
|
||||
|
||||
.PARAMETER Force
|
||||
Force the disconnect, even if the disconnect would fail.
|
||||
@ -36,197 +32,194 @@ function Disconnect-From {
|
||||
[None]
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "ucs.myside.local" -Type CiscoUcs
|
||||
Disconnect-From -RemoteHost 'vc.domain.local' -Type CisServer
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "ftp.myside.local" -Type FTP
|
||||
Disconnect-From -RemoteHost 'ucs.domain.local' -Type CiscoUcs
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "fas.myside.local" -Type NetAppFAS
|
||||
Disconnect-From -RemoteHost 'ucs-central.domain.local' -Type 'CiscoUcsCentral'
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware
|
||||
Disconnect-From -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTP
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "esx01.myside.local" -Type VMware -Force:$True
|
||||
Disconnect-From -RemoteHost 'exchange01.domain.local' -Type ExchangeHTTPS
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "vcenter.myside.local" -Type CisServer
|
||||
Disconnect-From -RemoteHost 'ftp.domain.local' -Type FTP
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTP
|
||||
Disconnect-From -RemoteHost 'fas.domain.local' -Type NetAppFAS
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost "exchange01.myside.local" -Type ExchangeHTTPS
|
||||
Disconnect-From -RemoteHost 'grid.domain.local' -Type NetAppStorageGRID
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost 'esx01.domain.local' -Type VMware
|
||||
|
||||
.EXAMPLE
|
||||
Disconnect-From -RemoteHost 'esx01.domain.local' -Type VMware -Force:$True
|
||||
|
||||
#>
|
||||
|
||||
[CmdletBinding()]
|
||||
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
|
||||
'PSAvoidGlobalVars',
|
||||
'',
|
||||
Justification = 'Wrapping existing global vars from external modules'
|
||||
)]
|
||||
|
||||
param (
|
||||
[Parameter(Mandatory = $true)]
|
||||
[string]$RemoteHost,
|
||||
[string] $RemoteHost,
|
||||
|
||||
[Parameter(Mandatory = $true)]
|
||||
[ValidateSet(
|
||||
'CiscoUcs',
|
||||
'CiscoUcsCentral',
|
||||
'FTP',
|
||||
'NetAppFAS',
|
||||
'VMware',
|
||||
'CisServer',
|
||||
'ExchangeHTTP',
|
||||
'ExchangeHTTPS',
|
||||
'SCP'
|
||||
'FTP',
|
||||
'NetAppFAS',
|
||||
'NetAppStorageGRID',
|
||||
'SCP',
|
||||
'VMware',
|
||||
'VMwareCisServer'
|
||||
)]
|
||||
[string]$Type,
|
||||
[string] $Type,
|
||||
|
||||
[Parameter(Mandatory = $false)]
|
||||
[switch]$Force
|
||||
[switch] $Force
|
||||
)
|
||||
|
||||
begin {}
|
||||
begin {
|
||||
# Set sane defaults for Progress, ErrorAction and InformationPreference
|
||||
$ProgressPreference = 'SilentlyContinue'
|
||||
$ErrorActionPreference = 'Stop'
|
||||
$InformationPreference = 'Continue'
|
||||
}
|
||||
|
||||
process {
|
||||
switch -Regex ($Type) {
|
||||
"VMware" {
|
||||
'CiscoUcs' {
|
||||
try {
|
||||
if ($Force) {
|
||||
Disconnect-VIServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop' -Force:$true
|
||||
}
|
||||
else {
|
||||
Disconnect-VIServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop'
|
||||
}
|
||||
$null = Disconnect-Ucs -Ucs $RemoteHost
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
"CisServer" {
|
||||
try {
|
||||
if ($Force) {
|
||||
Disconnect-CisServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop' -Force:$true
|
||||
}
|
||||
else {
|
||||
Disconnect-CisServer -Server $RemoteHost -Confirm:$false -ErrorAction 'Stop'
|
||||
}
|
||||
}
|
||||
|
||||
'CiscoUCSCentral' {
|
||||
try {
|
||||
$null = Disconnect-UcsCentral -Name $RemoteHost
|
||||
$ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $null)
|
||||
}
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
'ExchangeHTTP*' {
|
||||
try {
|
||||
Get-Variable -Name 'PSExchangeRemote' -Scope 'Global'
|
||||
Remove-PSSession -Session $global:PSExchangeRemote
|
||||
}
|
||||
catch {
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
# Check for an existing WinSCP Session var
|
||||
"FTP" {
|
||||
if ($Global:WinSCPSession.Opened) {
|
||||
Remove-WinSCPSession -WinSCPSession $Global:WinSCPSession
|
||||
'FTP' {
|
||||
if ($global:WinSCPSession.Opened) {
|
||||
Remove-WinSCPSession -WinSCPSession $global:WinSCPSession
|
||||
}
|
||||
else {
|
||||
$MessageParams = @{
|
||||
Message = 'There is no open WinSCP Session'
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message 'There is no open WinSCP Session'
|
||||
}
|
||||
}
|
||||
|
||||
# DataONTAP doesn't have a CmdLet `Disconnect-NcController`.
|
||||
# So we go ahead and clear the CurrentNcController variable.
|
||||
"NetAppFAS" {
|
||||
'NetAppFAS' {
|
||||
try {
|
||||
$MessageParams = @{
|
||||
Message = (
|
||||
"Setting {0} to `$null, which will disconnect NetAppFAS" -f $Global:CurrentNcController
|
||||
)
|
||||
ErrorAction = 'Continue'
|
||||
}
|
||||
Write-Verbose @MessageParams
|
||||
$Global:CurrentNcController = $null
|
||||
$m = 'Setting {0} to $null, which will disconnect NetAppFAS' -f $global:CurrentNcController
|
||||
Write-Verbose -Message $m
|
||||
$global:CurrentNcController = $null
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
|
||||
}
|
||||
"CiscoUcs" {
|
||||
|
||||
'NetAppSGWS' {
|
||||
try {
|
||||
Disconnect-Ucs -Ucs $RemoteHost
|
||||
$null = Disconnect-SgwServer -Server $RemoteHost
|
||||
$null = Remove-Variable -Name CurrentSgwServer -Scope Global -ErrorAction 'SilentlyContinue'
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
}
|
||||
"CiscoUCSCentral" {
|
||||
try {
|
||||
$handle = Connect-UcsCentral -Name $RemoteHost -Credential $creds -NotDefault
|
||||
$ExecutionContext.SessionState.PSVariable.Set('DefaultUcsCentral', $handle)
|
||||
}
|
||||
catch {
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
"ExchangeHTTP*" {
|
||||
try {
|
||||
Get-Variable -Name 'PSExchangeRemote' -Scope 'Global' -ErrorAction 'Stop'
|
||||
Remove-PSSession -Session $Global:PSExchangeRemote -ErrorAction 'Stop'
|
||||
}
|
||||
catch {
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
}
|
||||
}
|
||||
"SCP" {
|
||||
if ($Global:WinSCPSession.Opened) {
|
||||
Remove-WinSCPSession -WinSCPSession $Global:WinSCPSession
|
||||
'SCP' {
|
||||
if ($global:WinSCPSession.Opened) {
|
||||
Remove-WinSCPSession -WinSCPSession $global:WinSCPSession
|
||||
}
|
||||
else {
|
||||
$MessageParams = @{
|
||||
Message = 'There is no open WinSCP Session'
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message 'There is no open WinSCP Session'
|
||||
}
|
||||
}
|
||||
|
||||
'VMware' {
|
||||
# Construct the splatting for Disconnect-VIServer
|
||||
$params = @{
|
||||
Server = $RemoteHost
|
||||
Confirm = $false
|
||||
}
|
||||
|
||||
if ($PSBoundParameters.ContainsKey('Force')) {
|
||||
$params.Add('Force', $true)
|
||||
}
|
||||
|
||||
try {
|
||||
$null = Disconnect-VIServer @params
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
'VMwareCisServer' {
|
||||
try {
|
||||
if ($Force) {
|
||||
$null = Disconnect-CisServer -Server $RemoteHost -Confirm:$false -Force:$true
|
||||
}
|
||||
else {
|
||||
$null = Disconnect-CisServer -Server $RemoteHost -Confirm:$false
|
||||
}
|
||||
}
|
||||
|
||||
catch {
|
||||
# Write a error message to the log.
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
|
||||
default {
|
||||
# Write a error message to the log.
|
||||
$MessageParams = @{
|
||||
Message = "Unable to disconnect from {0} using Type {1}." -f $RemoteHost, $Type
|
||||
ErrorAction = 'Stop'
|
||||
}
|
||||
Write-Error @MessageParams
|
||||
Write-Error -Message ('Unable to disconnect from {0} using Type {1}.' -f $RemoteHost, $Type)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -143,7 +143,36 @@
|
||||
# RequireLicenseAcceptance = $false
|
||||
|
||||
# External dependent modules of this module
|
||||
# ExternalModuleDependencies = @()
|
||||
ExternalModuleDependencies = @(
|
||||
@{
|
||||
ModuleName = 'VMware.VimAutomation.Core'
|
||||
ModuleVersion = '6.5.2.6234650'
|
||||
},
|
||||
@{
|
||||
ModuleName = 'VMware.VimAutomation.Cis.Core'
|
||||
ModuleVersion = '6.5.4.6983166'
|
||||
},
|
||||
@{
|
||||
ModuleName = 'Cisco.UCS.Core'
|
||||
ModuleVersion = '2.3.1.5'
|
||||
},
|
||||
@{
|
||||
ModuleName = 'Cisco.UCSManager'
|
||||
ModuleVersion = '2.5.2.2'
|
||||
},
|
||||
@{
|
||||
ModuleName = 'WinSCP'
|
||||
ModuleVersion = '5.17.8.1'
|
||||
},
|
||||
@{
|
||||
ModuleName = 'DataONTAP'
|
||||
ModuleVersion = '9.7.1.1'
|
||||
},
|
||||
@{
|
||||
ModuleName = 'StorageGRID-WebScale'
|
||||
ModuleVersion = '7.2.1'
|
||||
}
|
||||
)
|
||||
|
||||
} # End of PSData hashtable
|
||||
|
||||
|
@ -1,60 +0,0 @@
|
||||
BeforeAll {
|
||||
$ManifestFile = (Get-Item -Path "./src/*.psd1").FullName
|
||||
Import-Module $ManifestFile -Force
|
||||
|
||||
$PrivateFunctions = (Get-ChildItem -Path "./src/Private/*.ps1" | Where-Object {
|
||||
$_.BaseName -notmatch '.Tests'
|
||||
}
|
||||
).FullName
|
||||
foreach ( $func in $PrivateFunctions) {
|
||||
. $func
|
||||
}
|
||||
}
|
||||
|
||||
Describe "Resolve-Dependency" {
|
||||
Context "Basic syntax check" {
|
||||
BeforeAll {
|
||||
Mock Get-ModuleBase {
|
||||
return (Join-Path -Path $PWD -ChildPath '/resources')
|
||||
}
|
||||
Mock Test-Module {
|
||||
return $true
|
||||
}
|
||||
}
|
||||
|
||||
It "Test1: Should not throw" {
|
||||
{ Resolve-Dependency -Name 'foobar2000' } | Should -Not -Throw
|
||||
}
|
||||
It "Test2: Output type should be bool" {
|
||||
Resolve-Dependency -Name 'foobar2000' | Should -BeOfType bool
|
||||
}
|
||||
}
|
||||
Context "Enforce Error" {
|
||||
# Return incorrect module base to enforce there is no config file.
|
||||
Mock Get-ModuleBase {
|
||||
if ($IsWindows) { return "C:\" }
|
||||
elseif ($isLinux) { return "/" }
|
||||
}
|
||||
It "Missing dependency file should not cause an error" {
|
||||
{ Resolve-Dependency -Name 'awesome' } | Should -Not -Throw
|
||||
}
|
||||
|
||||
It "Missing dependency file should return true" {
|
||||
Resolve-Dependency -Name 'awesome' | Should -Be $true
|
||||
}
|
||||
}
|
||||
Context "Testing input variations" {
|
||||
It "Should return true if all given dependencies exist" {
|
||||
Mock Get-ModuleBase {
|
||||
return (Join-Path -Path $PWD -ChildPath '/resources')
|
||||
}
|
||||
Resolve-Dependency -Name 'Existing' | Should -Be $true
|
||||
}
|
||||
It "Mixed results should return false" {
|
||||
Mock Get-ModuleBase {
|
||||
return (Join-Path -Path $PWD -ChildPath '/resources')
|
||||
}
|
||||
Resolve-Dependency -Name 'PSGetMixed' | Should -Be $false
|
||||
}
|
||||
}
|
||||
}
|
@ -1,87 +0,0 @@
|
||||
function Resolve-Dependency {
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Tests defined optional dependencies and returns the result as bool.
|
||||
|
||||
.DESCRIPTION
|
||||
Use this function to test for optional modules. You can use it if you provide functions which needs special
|
||||
modules but you don't want to make them required.
|
||||
|
||||
Place a file called Dependency.json in your module root dir. The default format is:
|
||||
|
||||
{
|
||||
"Version": 0.1,
|
||||
"Mandatory": {},
|
||||
"Optional": [
|
||||
{
|
||||
"Name": "VMware",
|
||||
"Modules": [
|
||||
"VMware.VimAutomation.Core"
|
||||
]
|
||||
},
|
||||
{
|
||||
"Name": "CiscoUCS",
|
||||
"Modules": []
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
.PARAMETER Name
|
||||
Select the dependency item name you defined in the dependency.json.
|
||||
.INPUTS
|
||||
[None]
|
||||
|
||||
.OUTPUTS
|
||||
[bool]
|
||||
|
||||
.EXAMPLE
|
||||
If (-not (Resolve-Dependency -Name 'VMware')) {
|
||||
Write-Error -Message (
|
||||
"Could not resolve the optional dependencies defined for {0}" -f 'VMware'
|
||||
) -ErrorAction 'Stop'
|
||||
}
|
||||
#>
|
||||
|
||||
[OutputType([bool])]
|
||||
[CmdletBinding()]
|
||||
param (
|
||||
[Parameter(Mandatory = $true)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string]$Name
|
||||
)
|
||||
|
||||
begin {
|
||||
$ModuleRootDir = Get-ModuleBase
|
||||
$DepFilePath = Join-Path -Path $ModuleRootDir -ChildPath "Dependency.json"
|
||||
if (Test-Path -Path $DepFilePath) {
|
||||
$Dependency = Get-Content -Path $DepFilePath -Raw -Encoding UTF8 | ConvertFrom-Json
|
||||
}
|
||||
else {
|
||||
Write-Warning ("Could not find the dependency file: {0}" -f $DepFilePath)
|
||||
}
|
||||
}
|
||||
|
||||
process {
|
||||
# ScriptAnalyzer issue workaround (unused var)
|
||||
$null = $Name
|
||||
$SelectedDependency = $Dependency.Optional | Where-Object { $_.Name -match $Name }
|
||||
# return true if there is no dependency defined
|
||||
if ($null -eq $SelectedDependency) {
|
||||
return $true
|
||||
}
|
||||
|
||||
$res = @()
|
||||
foreach ($Module in $SelectedDependency.Modules) {
|
||||
$res += Test-Module -Name $Module
|
||||
}
|
||||
# return false if there was not module at all
|
||||
if (($res -contains $false) -or ($res.Count -eq 0)) {
|
||||
return $false
|
||||
}
|
||||
else {
|
||||
return $true
|
||||
}
|
||||
}
|
||||
|
||||
end {}
|
||||
}
|
Reference in New Issue
Block a user