< Back

Get-OctopusToolVersion

Sat Jan 18, 2020 5:30 pm

NAME Get-OctopusToolVersion



SYNOPSIS

Gets a list of available versions of Octo.exe in the folder set on the "Octopus Tools Folder". If you don't know

what this path is run [Get-Help Set-OctopusToolsFolder] to learn more about it



For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder

structure must be like this:



["Octopus Tools Folder"]\\[Child Folder]\\Octo.exe



For example, given the following structure:



["Octopus Tools Folder"]\\1.0.0\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\AnotherFolder\\Octo.exe



The first 2 Octo.exe versions will be properly discovered, but the 3rd one wont because its not on the root of a

direct child of the "Octopus Tools Folder"





SYNTAX

Get-OctopusToolVersion [-Latest <SwitchParameter>] [<CommonParameters>]



Get-OctopusToolVersion [[-Version] <string>] [<CommonParameters>]





DESCRIPTION

Gets a list of available versions of Octo.exe in the folder set on the "Octopus Tools Folder". If you don't know

what this path is run [Get-Help Set-OctopusToolsFolder] to learn more about it



For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder

structure must be like this:



["Octopus Tools Folder"]\\[Child Folder]\\Octo.exe



For example, given the following structure:



["Octopus Tools Folder"]\\1.0.0\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\Octo.exe



["Octopus Tools Folder"]\\SomeFolderName\\AnotherFolder\\Octo.exe



The first 2 Octo.exe versions will be properly discovered, but the 3rd one wont because its not on the root of a

direct child of the "Octopus Tools Folder"





PARAMETERS

-Latest <SwitchParameter>

If set to TRUE the cmdlet will only return the highest version of Octo.exe found on the child folders

$env:OctopusToolsFolder. If you don't know what this path is run [Get-Help Set-OctopusToolsFolder] to learn

more about it



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Version <string>

Gets a specific version of Octo.exe



Required? false

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

Gets a specific version of Octo.exe





OUTPUTS

Octoposh.Model.OctopusToolVersion



System.Collections.Generic.List`1[[Octoposh.Model.OctopusToolVersion, Octoposh, Version=1.0.0.0, Culture=neutral,

PublicKeyToken=null]]





---------- EXAMPLE 1 ----------



PS C:\\> Get-OctopusToolVersion



Gets a list of available versions of Octo.exe in the folder set on the "Octopus Tools Folder".

---------- EXAMPLE 2 ----------



PS C:\\> Get-OctopusToolVersion -latest



Gets the latest version of Octo.exe in the folder set on the "Octopus Tools Folder".



RELATED LINKS

WebSite: http://Octoposh.net

Github Project: https://github.com/Dalmirog/OctoPosh/

Wiki: http://octoposh.readthedocs.io

QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial