Public/Get-RubrikReplicationTarget.ps1

#Requires -Version 3
function Get-RubrikReplicationTarget
{
  <#
      .SYNOPSIS
      Connects to Rubrik and retrieves summaries of all replication target clusters
 
      .DESCRIPTION
      The Get-RubrikReplicationTarget cmdlet will retrieve summaries of all of the clusters configured as a replication target
 
      .NOTES
      Written by Mike Preston for community usage
      Twitter: @mwpreston
      GitHub: mwpreston
 
      .LINK
      https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikreplicationtarget
 
      .EXAMPLE
      Get-RubrikReplicationTarget
      This will return the details of all replication targets configured on the Rubrik cluster
 
      .EXAMPLE
      Get-RubrikReplicationTarget -Name 'cluster.domain.local'
      This will return the most common details of the replication target named 'cluster.domain.local' configured on the Rubrik cluster
 
      .EXAMPLE
      Get-RubrikReplicationTarget -Name 'cluster.domain.local' -DetailedObject
      This will return all of the the details of the replication target named 'cluster.domain.local' configured on the Rubrik cluster
 
      .EXAMPLE
      Get-RubrikReplicationTarget -id '11111-22222-33333'
      This will return the details of the replication target with an id of '11111-22222-33333' configured on the Rubrik cluster
  #>


  [CmdletBinding(DefaultParameterSetName = 'Query')]
  Param(
    # Replication target ID
    [ValidateNotNullOrEmpty()]
    [Parameter(
        ParameterSetName='ID',
        Position = 0,
        Mandatory = $true,
        ValueFromPipelineByPropertyName = $true)]
    [String]$Id,
    # Replication target Cluster Name
    [ValidateNotNullOrEmpty()]
    [Parameter(
        ParameterSetName='Query',
        Position = 0)]
    [Alias('Name')]
    [String]$targetClusterName,
    # DetailedObject will retrieved the detailed replication target object, the default behavior of the API is to only retrieve a subset of the full replication target object unless we query directly by ID. Using this parameter does affect performance as more data will be retrieved and more API-queries will be performed.
    [Parameter(ParameterSetName='Query')]
    [Switch]$DetailedObject,
    # Rubrik server IP or FQDN
    [String]$Server = $global:RubrikConnection.server,
    # API version
    [ValidateNotNullorEmpty()]
    [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

    # if detailed object is passed, loop through to get more information
    if (($DetailedObject) -and (-not $PSBoundParameters.containskey('id'))) {
      Write-Verbose -Message "DetailedObject detected, requerying for more detailed results"
      $result = Get-RubrikDetailedResult -result $result -cmdlet "$($MyInvocation.MyCommand.Name)"
    }
    return $result

  } # End of process
} # End of function