Public/Get-RubrikNASShare.ps1
|
#requires -Version 3 function Get-RubrikNASShare { <# .SYNOPSIS Get information on NAS shares. .DESCRIPTION Get all information for NAS shares configured within Rubrik. .NOTES Written by Mike Fal Twitter: @Mike_Fal GitHub: MikeFal .LINK https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubriknasshare .EXAMPLE Get-RubrikNASShare -ShareType 'SMB' Get all SMB NAS Shares .EXAMPLE Get-RubrikHost -name 'FOO' | Get-RubrikNASShare Get all NAS Shares attached to host 'FOO'. #> [CmdletBinding()] Param( # NAS Share ID [Parameter(ValueFromPipelineByPropertyName = $true)] [String]$ID, # Host ID associated with the share [Alias('host_id')] [string]$HostID, #Share type (NFS or SMB) [ValidateSet('NFS','SMB')] [Alias('share_type')] [String]$ShareType, #Host name [String]$HostName, #export point [String]$exportPoint, # Rubrik server IP or FQDN [String]$Server = $global:RubrikConnection.server, # Filter the summary information based on the primarycluster_id of the primary Rubrik cluster. Use 'local' as the primary_cluster_id of the Rubrik cluster that is hosting the current REST API session. [Parameter(ParameterSetName='Query')] [ValidateNotNullOrEmpty()] [Alias('primary_cluster_id')] [String]$PrimaryClusterID, # 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 = Set-ObjectTypeName -TypeName $resources.ObjectTName -result $result return $result } # End of process } # End of function |