Cohesity.PowerShell.Core

1.9.6

Scripts/ProtectionSource/Get-CohesityAgentStatus.ps1

function Get-CohesityAgentStatus {
    <#
        .SYNOPSIS
        Gets a list of the agent status of physical servers.
        .DESCRIPTION
        Gets a list of the agent status of physical servers.
        .NOTES
        Published by Cohesity
        .LINK
        https://cohesity.github.io/cohesity-powershell-module/#/README
        .EXAMPLE
        Get-CohesityAgentStatus
        Returns the agent status of physcial servers. The attributes authenticationErrorMessage and refreshErrorMessage would provide the error messages.
    #>
    [OutputType('System.Array')]
    [CmdletBinding()]
    Param(
    )

    Begin {
    }

    Process {
            $cohesityUrl = '/irisservices/api/v1/public/protectionSources/registrationInfo?includeEntityPermissionInfo=true&includeApplicationsTreeInfo=false&allUnderHierarchy=true&environments=kPhysical'
            $resp = Invoke-RestApi -Method Get -Uri $cohesityUrl
            if (200 -eq $Global:CohesityAPIStatus.StatusCode) {
                $nodes = $resp.rootNodes
                # tagging reponse for display format ( configured in Cohesity.format.ps1xml )
                @($nodes | Add-Member -TypeName 'System.Object#AgentStatus' -PassThru)
            }
    }

    End {
    }
}