Public/Set-RubrikProxySetting.ps1
|
#Requires -Version 3 function Set-RubrikProxySetting { <# .SYNOPSIS Set a Rubrik Proxy Settings .DESCRIPTION The Set-RubrikProxySetting cmdlet will set proxy configuration information for the cluster nodes. .NOTES Written by Jaap Brasser for community usage Twitter: @jaap_brasser GitHub: jaapbrasser .LINK https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/set-rubrikproxysetting .EXAMPLE Set-RubrikProxySetting -Host build.rubrik.com -Port 8080 -Protocol HTTPS Set the Cluster proxy configuration to the settings listed .EXAMPLE Set-RubrikProxySetting -Host build.rubrik.com -Port 8080 -Protocol HTTPS -UserName jaapbrasser -Password $SecurePW Set the cluster proxy information to the settings specified in the function parameter #> [CmdletBinding()] Param( # The proxy FQDN or ip address [Parameter( Mandatory = $true)] [Alias('host')] [string] $proxyhostname, # The protocal that is used by proxy [Parameter( Mandatory = $true)] [Validateset('HTTP','HTTPS','SOCKS5')] [string] $Protocol, # Optional, port number for Proxy Configuration [int] $port, # Optional parameter, user name for proxy [string] $Username, # Optional parameter, password for proxy [securestring] $password, # Rubrik server IP or FQDN [Parameter( ValueFromPipelineByPropertyName = $true)] [Alias('ipAddress','NodeIPAddress')] [String]$Server = $global:RubrikConnection.server, # API version [String]$api = $global:RubrikConnection.api ) Begin { # The Begin section is used to perform one-time loads of data necessary to carry out the function's purpose # If a command needs to be run with each iteration or pipeline input, place it in the Process section # Check to ensure that a session to the Rubrik cluster exists and load the needed header data for authentication Test-RubrikConnection # API data references the name of the function # For convenience, that name is saved here to $function $function = $MyInvocation.MyCommand.Name # Retrieve all of the URI, method, body, query, result, filter, and success details for the API endpoint Write-Verbose -Message "Gather API Data for $function" $resources = Get-RubrikAPIData -endpoint $function Write-Verbose -Message "Load API data for $($resources.Function)" Write-Verbose -Message "Description: $($resources.Description)" } Process { $uri = New-URIString -server $Server -endpoint ($resources.URI) -id $id $uri = Test-QueryParam -querykeys ($resources.Query.Keys) -parameters ((Get-Command $function).Parameters.Values) -uri $uri $body = New-BodyString -bodykeys ($resources.Body.Keys) -parameters ((Get-Command $function).Parameters.Values) $result = Submit-Request -uri $uri -header $Header -method $($resources.Method) -body $body $result = Test-ReturnFormat -api $api -result $result -location $resources.Result $result = Test-FilterObject -filter ($resources.Filter) -result $result $result = $result | Select-Object -Property *,@{ name = 'NodeIPAddress' expression = { $server } } $result = Set-ObjectTypeName -TypeName $resources.ObjectTName -result $result return $result } # End of process } # End of function |