Public/Get-AGMLibFollowJobStatus.ps1

# Copyright 2022 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


Function Get-AGMLibFollowJobStatus ([string]$jobname) 
{
    <#
    .SYNOPSIS
    Tracks job status for a nominated job
 
    .EXAMPLE
    Get-AGMLibFollowJobStatus
    You will be prompted for a JobName
 
    .EXAMPLE
    Get-AGMLibFollowJobStatus Job_1234
    Tracks the progress of Job_1234 to conclusion. Tracking will stop when the job completes, is canceled or fails.
 
 
    .DESCRIPTION
    A function to follow the progress with 5 second intervals until the job succeeds or is not longer running or queued
 
    #>



    if ( (!($AGMSESSIONID)) -or (!($AGMIP)) )
    {
        Get-AGMErrorMessage -messagetoprint "Not logged in or session expired. Please login using Connect-AGM"
        return
    }
    $sessiontest = Get-AGMVersion
    if ($sessiontest.errormessage)
    {
        $sessiontest
        return
    }
    

    if (!($jobname))
    {
        $jobname = Read-Host "JobName"
    }
    
    $done = 0
    do 
    {
        $jobgrab = Get-AGMJobStatus -filtervalue jobname=$jobname
        if ($jobgrab.errormessage)
        {   
            $done = 1
            $jobgrab
        }    
        elseif (!($jobgrab.status)) 
        {
            Get-AGMErrorMessage -messagetoprint "Failed to find $jobname"
            $done = 1
        }
        elseif ($jobgrab.status -like "queued")
        {
            $jobgrab | select-object jobname, status, queuedate, targethost | Format-Table
            Start-Sleep -s 5
        }
        elseif ($jobgrab.status -like "initializing")
        {
            $jobgrab | select-object jobname, status, queuedate, targethost | Format-Table
            Start-Sleep -s 5
        }
        elseif ($jobgrab.status -like "running") 
        {
            $jobgrab | select-object jobname, status, progress, queuedate, startdate, duration, targethost | Format-Table
            Start-Sleep -s 5
        }
        else 
        {
            $jobgrab | select-object jobname, status, message, startdate, enddate, duration, targethost
            $done = 1    
        }
    } until ($done -eq 1)
}