Public/Connect-SDP.ps1
|
<# .SYNOPSIS Connects you to an SDP instance. .DESCRIPTION This is the function for establishing a session to an existing SDP. .PARAMETER server [string] - Management IP or name for the SDP console. .PARAMETER credential [PSCredential] - A credential object to use to provide authentication to the desired SDP. .PARAMETER k2context [string] - Specify a context .EXAMPLE $creds = get-credential Connect-SDP -Server 10.10.47.16 -Credentials $cred This will connect you to an existing SDP. .LINK https://github.com/silk-us/silk-sdp-powershell-sdk #> function Connect-SDP { param( [parameter(Mandatory)] [string] $server, [parameter(Mandatory)] [System.Management.Automation.PSCredential] $credentials, [parameter()] [switch] $throttleCorrection, [parameter()] [switch] $resolve, [parameter()] [string] $k2context = 'k2rfconnection' ) <# .SYNOPSIS Connect to a Kaminario K2 appliance. .DESCRIPTION Connect to a Kaminario K2 appliance. .PARAMETER server The SDP management IP or DNS name. .PARAMETER throttleCorrection Switch to help correct API overruns. Use this if you are experiencing "slow down" messages in pipelines. .PARAMETER resolve Switch for automatically resolving .ref paths. .PARAMETER credentials A standard PowerShell credential object (System.Management.Automation.PSCredential) .INPUTS Connect-SDP does not accept piped inputs. .OUTPUTS Returns the SDP 'system/state' endpoint information. .EXAMPLE Connect-SDP -credentials $creds -server 10.10.1.20 This connects ad-hoc to a Kaminario appliace using a conventional powershell credential object under a default global context. .EXAMPLE Connect-SDP -credentials $creds -server 172.16.2.13 -k2context TestDev This connects ad-hoc to a Kaminario appliace using a conventional powershell credential object under a specific context, for later issuing commands to a specific K2 appliance (Get-SDPVolumeGroup -k2context TestDev) .EXAMPLE Connect-SDP -credentials $creds -server 10.10.1.20 -throttleCorrection This connects ad-hoc to a Kaminario appliace using a conventional powershell credential object under a default global context. It enforces a throttle reduction of 1 second between API requests and responses. #> # $K2header = New-SDPAPIHeader -Credential $credentials $o = New-Object psobject $o | Add-Member -MemberType NoteProperty -Name 'credentials' -Value $credentials $o | Add-Member -MemberType NoteProperty -Name 'K2Endpoint' -Value $server $o | Add-Member -MemberType NoteProperty -Name 'throttleCorrection' -Value $throttleCorrection $o | Add-Member -MemberType NoteProperty -Name 'resolve' -Value $resolve Set-Variable -Name $k2context -Value $o -Scope Global $results = Invoke-SDPRestCall -endpoint 'system/state' -method GET -k2context $k2context return $results } |