Octoposh.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Octoposh</name> </assembly> <members> <member name="T:Octoposh.Cmdlets.GetOctopusServerThumbprint"> <summary> <para type="synopsis">Gets the Octopus Server thumbprint. Admin access in the Octopus instance will be needed for this to work</para> </summary> <summary> <para type="synopsis">Gets the Octopus Server thumbprint. Admin access in the Octopus instance will be needed for this to work</para> </summary> <example> <code>PS C:\> Get-OctopusServerThumbprint</code> <para>Gets the thumbprint of the Octopus Server</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="T:Octoposh.Cmdlets.GetOctopusChannel"> <summary> <para type="Description">Gets information about Octopus Channels</para> </summary> <summary> <para type="synopsis">Gets information about Octopus Channels</para> </summary> <example> <code>PS C:\> Get-OctopusChannel</code> <para>Gets all the channels in all the projects of the instance</para> </example> <example> <code>PS C:\> Get-OctopusChannel -Project "MyFinantialApp"</code> <para>Gets all the channels of the project "MyFinantialApp"</para> </example> <example> <code>PS C:\> Get-OctopusChannel -name "Hotfix_Website" -Project "MyFinantialApp"</code> <para>Gets the Channel with the name "Hotfix_Website" of the project "MyFinantialApp"</para> </example> <example> <code>PS C:\> Get-OctopusChannel -name "Hotfix_Website","Hotfix_WebService" -Project "MyFinantialApp"</code> <para>Gets the Channels with the names "Hotfix_Website" and "Hotfix_WebService" of the project "MyFinantialApp"</para> </example> <example> <code>PS C:\> Get-OctopusChannel -name "Hotfix_*" -Project "MyFinantialApp"</code> <para>Gets all the Channels whose name starts with "Hotfix_" of the project "MyFinantialApp"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusChannel.ChannelName"> <summary> <para type="description">Channel name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusChannel.ProjectName"> <summary> <para type="description">Project name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusChannel.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusConnectionInfo"> <summary> <para type="synopsis">This function gets the data of the variables $env:OctopusURI and $env:OctopusAPI that are used by all the cmdlets of the Octoposh module</para> </summary> <summary> <para type="description">This function gets the data of the variables $env:OctopusURI and $env:OctopusAPI that are used by all the cmdlets of the Octoposh module</para> </summary> <example> <code>PS C:\> Get-OctopusConnectionInfo</code> <para>Get the current connection info. Its the same as getting the values of $env:OctopusURL and $Env:OctopusAPIKey</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="T:Octoposh.Cmdlets.GetOctopusDashboard"> <summary> <para type="synopsis">Returns the Octopus Dashboard</para> </summary> <summary> <para type="description">Returns the Octopus Dashboard</para> </summary> <example> <code>PS C:\> Get-OctopusDashboard</code> <para>Gets the entire Octopus dashboard</para> </example> <example> <code>PS C:\> Get-OctopusDashboard -ProjectName MyWebApp</code> <para>Gets the dashboard info for the project MyWebApp</para> </example> <example> <code>PS C:\> Get-OctopusDashboard -EnvironmentName Production</code> <para>Gets the dashboard info for all the projects that have a release deployed to the "Production" environment.</para> </example> <example> <code>PS C:\> Get-OctopusDashboard -DeploymentStatus Success</code> <para>Gets all the deployments in "Success" status on the dashboard</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusDashboard.ProjectName"> <summary> <para type="description">Name of the Project to filter for.</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusDashboard.EnvironmentName"> <summary> <para type="description">Name of the Project to filter for.</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusDashboard.DeploymentStatus"> <summary> <para type="description">Target communication style to filter by</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusDeployment"> <summary> <para type="synopsis">Gets information about Octopus deployments</para> </summary> <summary> <para type="description">Gets information about Octopus deployments</para> </summary> <example> <code>PS C:\> Get-OctopusDeployment</code> <para> Get all the deployments that were done on the Octopus Instance. You might wanna go grab a coffee after hitting [enter] on this one, its gonna take a while.</para> </example> <example> <code>PS C:\> Get-OctopusDeployment -Project "MyProject" -ReleaseVersion 1.0.0</code> <para>Get all the deployments that were done for the release 1.0.0 of the project "MyProject"</para> </example> <example> <code>PS C:\> Get-OctopusDeployment -EnvironmentName "Staging","UAT" -ProjectName "MyService"</code> <para>Get all the deployents that were done to the environments Staging and UAT on the project "MyService"</para> </example> <example> <code>PS C:\> Get-OctopusDeployment -project "MyProduct.Webapp","MyProduct.service" -Environment "Production"</code> <para>Get all the deployments that were done to the environment "Production" on the projects "MyProduct.webapp" and "MyProduct.service"</para> </example> <example> <code>PS Get-OctopusDeployment -project "MyProduct.Webapp" -Environment "Production" -After 2/20/2017 -Before 2/21/2017</code> <para>Gets all the deployments for the project "MyProduct.WebApp" for the environment "Production" between 2/20/2017 and 2/21/2017</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="F:Octoposh.Cmdlets.GetOctopusDeployment.EnvironmentName"> <summary> <para type="description">Name of the Environment to filter by</para> </summary> </member> <member name="F:Octoposh.Cmdlets.GetOctopusDeployment.ProjectName"> <summary> <para type="description">Name of the Project to filter by</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusDeployment.ReleaseVersion"> <summary> <para type="description">Release version to filter by. The cmdlet will only return deployments that belong to these releases</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusDeployment.LatestReleases"> <summary> <para type="description">Gets deployments by latest X releases</para> </summary> </member> <member name="F:Octoposh.Cmdlets.GetOctopusDeployment.Before"> <summary> <para type="description">Target communication style to filter by</para> </summary> </member> <member name="F:Octoposh.Cmdlets.GetOctopusDeployment.After"> <summary> <para type="description">Target communication style to filter by</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusDeployment.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusEnvironment"> <summary> <para type="synopsis">Gets information about Octopus Environments</para> </summary> <summary> <para type="description">Gets information about Octopus Environments</para> </summary> <example> <code>PS C:\> Get-OctopusEnvironment -name Production</code> <para>Gets info about the environment "Production"</para> </example> <example> <code>PS C:\> Get-OctopusEnvironment -name "FeatureTest*"</code> <para>Gets info about all the environments whose name matches the pattern "FeatureTest*"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusEnvironment.EnvironmentName"> <summary> <para type="description">Environment name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusEnvironment.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusFeed"> <summary> <para type="synopsis">Gets information about the external feeds registered in Octopus</para> </summary> <summary> <para type="description">Gets information about the external feeds registered in Octopus</para> </summary> <example> <code>PS C:\> Get-OctopusFeed</code> <para>Get all the external feeds registered in the current Instance</para> </example> <example> <code>PS C:\> Get-OctopusFeed -FeedName "MyGet"</code> <para>Get the External Feed named "MyGet"</para> </example> <example> <code>PS C:\> Get-OctopusFeed -URL "*Mycompany*"</code> <para>Get a feed with a the string "MyCompany" inside its URL</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusFeed.FeedName"> <summary> <para type="description">Feed name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusFeed.URL"> <summary> <para type="description">Feed URL/Path </para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusFeed.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusToolPath"> <summary> <para type="synopsis">This cmdlet returns the full path of the current Octo.exe version set as default. To learn how to set this path run Get-Help Set-OctopusToolPath</para> <para type="synopsis">In the background [Get-OctopusToolPath] and [Set-OctopusToolPath] simply Get/Set the value of the environment variable $env:OctoExe</para> </summary> <summary> <para type="description">This cmdlet returns the full path of the current Octo.exe version set as default. To learn how to set this path run Get-Help Set-OctopusToolPath</para> <para type="description">In the background [Get-OctopusToolPath] and [Set-OctopusToolPath] simply Get/Set the value of the environment variable $env:OctoExe</para> </summary> <example> <code>PS C:\> Get-OctopusToolPath</code> <para>returns the full path of the current Octo.exe version set as default.</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="T:Octoposh.Cmdlets.GetOctopusToolsFolder"> <summary> <para type="synopsis">This cmdlet gets the path of the "Octopus Tools Folder" that will be used by other Octoposh cmdlets. To learn how to set this path and what its the expected file structure on it, run Get-Help Set-OctopusToolsFolder</para> <para type="synopsis">In the background [Get-OctopusToolsFolder] and [Set-OctopusToolsFolder] simply Get/Set the value of the environment variable $env:OctopusToolsFolder</para> </summary> <summary> <para type="description">This cmdlet gets the path of the "Octopus Tools Folder" that will be used by other Octoposh cmdlets. To learn how to set this path and what its the expected file structure on it, run Get-Help Set-OctopusToolsFolder</para> <para type="description">In the background [Get-OctopusToolsFolder] and [Set-OctopusToolsFolder] simply Get/Set the value of the environment variable $env:OctopusToolsFolder</para> </summary> <example> <code>PS C:\> Get-OctopusToolsFolder</code> <para>Gets the path of the "Octopus Tools Folder"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="T:Octoposh.Cmdlets.GetOctopusToolVersion"> <summary> <para type="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</para> <para type="synopsis">For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder structure must be like this:</para> <para type="synopsis">["Octopus Tools Folder"]\[Child Folder]\Octo.exe</para> <para type="synopsis">For example, given the following structure:</para> <para type="synopsis">["Octopus Tools Folder"]\1.0.0\Octo.exe</para> <para type="synopsis">["Octopus Tools Folder"]\SomeFolderName\Octo.exe</para> <para type="synopsis">["Octopus Tools Folder"]\SomeFolderName\AnotherFolder\Octo.exe</para> <para type="synopsis">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"</para> </summary> <summary> <para type="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</para> <para type="description">For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder structure must be like this:</para> <para type="description">["Octopus Tools Folder"]\[Child Folder]\Octo.exe</para> <para type="description">For example, given the following structure:</para> <para type="description">["Octopus Tools Folder"]\1.0.0\Octo.exe</para> <para type="description">["Octopus Tools Folder"]\SomeFolderName\Octo.exe</para> <para type="description">["Octopus Tools Folder"]\SomeFolderName\AnotherFolder\Octo.exe</para> <para type="description">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"</para> </summary> <example> <code>PS C:\> Get-OctopusToolVersion</code> <para>Gets a list of available versions of Octo.exe in the folder set on the "Octopus Tools Folder".</para> </example> <example> <code>PS C:\> Get-OctopusToolVersion -latest</code> <para>Gets the latest version of Octo.exe in the folder set on the "Octopus Tools Folder".</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusToolVersion.Latest"> <summary> <para type="description">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</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusToolVersion.Version"> <summary> <para type="description">Gets a specific version of Octo.exe</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusVariableSet"> <summary> <para type="synopsis"> Gets Octopus Variable sets. These can belong to a specific Project or to a Library Variable set. "Variable set" is the name of the object that holds the collection of variables for both Projects and Library Sets.</para> </summary> <summary> <para type="synopsis"> Gets Octopus Variable sets. These can belong to a specific Project or to a Library Variable set. "Variable set" is the name of the object that holds the collection of variables for both Projects and Library Sets.</para> </summary> <example> <code>PS C:\> Get-OctopusVariableSet</code> <para>Gets all the Project and Library variable sets of the instance</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_SC"</code> <para>Gets the Variable Set of the Library Variable Set with the name "Stands_SC"</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_SC" -IncludeUsage</code> <para>Gets the Variable Set of the Library Variable Set "Stands_SC" and it also populates the output object property "Usage" with the list of projects that are currently using the set</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_SC","Stands_DII"</code> <para>Gets the LibraryVariableSets with the names "Stands_SC" and "Stands_DII"</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_*"</code> <para>Gets all the LibraryVariableSets whose name matches the pattern "Stands_*"</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_*" -IncludeLibrarySetUsage </code> <para>Gets all the LibraryVariableSets whose name matches the pattern "Stands_*". Each result will also include a list of Projects on which they are being used</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -ProjectName "Website_Stardust","Website_Diamond"</code> <para>Gets the Variable Sets of the Projects "Website_Stardust" and "Website_Diamond"</para> </example> <example> <code>PS C:\> Get-OctopusVariableSet -ProjectName "Website_Stardust" -LibrarySetName "Stands_SC"</code> <para>Gets the Variable Sets of the Project "Website_Stardust" and the Library variable set "Stands_SC"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusVariableSet.LibrarySetName"> <summary> <para type="description">Library Set name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusVariableSet.ProjectName"> <summary> <para type="description">Project name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusVariableSet.IncludeUsage"> <summary> <para type="description">If set to TRUE the list of Projects on which each Library Variable Set is being used will be displayer</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusVariableSet.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusLifecycle"> <summary> <para type="synopsis">This cmdlet returns information about Octopus Lifecycles</para> </summary> <summary> <para type="description">This cmdlet returns information about Octopus Lifecycles</para> </summary> <example> <code>PS C:\> Get-OctopusLifecycle</code> <para>Get all the Lifecycles of the current Instance</para> </example> <example> <code>PS C:\> Get-OctopusLifecycle -name MyLifecycle</code> <para>Get the Lifecycle named "MyLifecycle"</para> </example> <example> <code>PS C:\> Get-OctopusLifecycle -name "ProjectA_Lifecycle","ProjectB_Lifecycle"</code> <para>Gets the teams with the names "ProjectA_Lifecycle" and "ProjectB_Lifecycle"</para> </example> <example> <code>PS C:\> Get-OctopusLifecycle -name "ProjectA*"</code> <para> Gets all the lifecycles whose name starts with "ProjectA"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusLifecycle.LifecycleName"> <summary> <para type="description">Lifecycle name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusLifecycle.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusMachine"> <summary> <para type="synopsis">This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</para> </summary> <summary> <para type="description">This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</para> </summary> <example> <code>PS C:\> Get-OctopusMachine -name "Database_Prod"</code> <para>Gets the machine with the name "Database_Prod"</para> </example> <example> <code>PS C:\> Get-OctopusMachine -name "*_Prod"</code> <para>Gets all the machines which name is like "*_Prod"</para> </example> <example> <code>PS C:\> Get-OctopusMachine -EnvironmentName "Staging","UAT""</code> <para>Gets all the machines on the environments "Staging","UAT"</para> </example> <example> <code>PS C:\> Get-OctopusMachine -URL "*:10933"</code> <para>Gets all the machines with the string "*:10933" at the end of the URL</para> </example> <example> <code>PS Get-OctopusMachine -Mode Listening</code> <para>Gets all the machines registered in "Listening" mode. "Polling" is also a valid value</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusMachine.MachineName"> <summary> <para type="description">Name of the Machine to filter by</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusMachine.EnvironmentName"> <summary> <para type="description">Name of the Environment to filter by</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusMachine.URL"> <summary> <para type="description">Target URI to filter by</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusMachine.CommunicationStyle"> <summary> <para type="description">Target communication style to filter by</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusMachine.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusProject"> <summary> <para type="synopsis">This cmdlet returns info about Octopus Projects</para> </summary> <summary> <para type="description">This cmdlet returns info about Octopus Projects</para> </summary> <example> <code>PS C:\> Get-OctopusProject</code> <para>Gets all the projects of the current Instance</para> </example> <example> <code>PS C:\> Get-OctopusProject -name MyProject</code> <para>Get the project named "MyProject"</para> </example> <example> <code>PS C:\> Get-OctopusProject -name MyApp*</code> <para>Get all the projects whose name starts with the string "MyApp"</para> </example> <example> <code>PS C:\> Get-OctopusProject -ProjectGroupName "MyProduct"</code> <para>Gets all the projects inside of the Project Group "MyProduct"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusProject.ProjectName"> <summary> <para type="description">Project name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusProject.ProjectGroupName"> <summary> <para type="description">Gets all projects inside a set of Project Groups</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusProject.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusProjectGroup"> <summary> <para type="synopsis">Gets information about Octopus Project Groups</para> </summary> <summary> <para type="description">Gets information about Octopus Project Groups</para> </summary> <example> <code>PS C:\> Get-OctopusProjectGroup</code> <para>Gets all the Project Groups on the Octopus instance</para> </example> <example> <code>PS C:\> Get-OctopusProjectGroup -name "MyProjects"</code> <para>Gets a Project Group named "MyProjects"</para> </example> <example> <code>PS C:\> Get-OctopusProjectGroup -name "*web*"</code> <para>Get all the projects whose name matches the pattern "*web*"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusProjectGroup.ProjectGroupName"> <summary> <para type="description">Project Group name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusProjectGroup.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusRelease"> <summary> <para type="synopsis">Gets information about Octopus Releases</para> </summary> <summary> <para type="description">Gets information about Octopus Releases</para> </summary> <example> <code>PS C:\> Get-OctopusRelease -ProjectName "MyProject"</code> <para>Get all the realeases of the project "MyProject"</para> </example> <example> <code>PS C:\> Get-OctopusRelease -ProjectName "MyProject" -version 1.0.1,1.0.2</code> <para>Get the release realeases 1.0.1 & 1.0.2 of the project "MyProject"</para> </example> <example> <code>PS C:\> Get-OctopusRelease -ProjectName "MyProject" -Latest 10</code> <para>Get the latest 10 releases of the project "MyProject"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusRelease.ReleaseVersion"> <summary> <para type="description">Release version number</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusRelease.ProjectName"> <summary> <para type="description">Name of project to filter releases. Only one Project can be passed to this parameter at a time</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusRelease.Latest"> <summary> <para type="description">Get latest X releases</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusRelease.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusResourceModel"> <summary> <para type="synopsis">This cmdlet creates instances of Octopus Resource Objects</para> </summary> <example> <code>PS C:\> $EnvironmentObj = Get-OctopusResourceModel -Resource Environment</code> <para>Creates an Environment Resource object</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusResourceModel.Resource"> <summary> <para type="description">Resource object model</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusTagSet"> <summary> <para type="Description">Gets information about Octopus TagSets</para> </summary> <summary> <para type="synopsis">Gets information about Octopus TagSets</para> </summary> <example> <code>PS C:\> Get-OctopusTagSet</code> <para>Gets all the TagSets of the instance</para> </example> <example> <code>PS C:\> Get-OctopusTagSet -name "Upgrade Ring"</code> <para>Gets the TagSet with the name "Upgrade Ring"</para> </example> <example> <code>PS C:\> Get-OctopusTagSet -name "Upgrade Ring","EAP"</code> <para>Gets the TagSets with the names "Upgrade Ring" and "EAP"</para> </example> <example> <code>PS C:\> Get-OctopustagSet -name "*_Customers"</code> <para>Gets all the TagSets whose name matches the pattern "*_Customers"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusTagSet.TagSetName"> <summary> <para type="description">TagSet name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusTagSet.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusTeam"> <summary> <para type="synopsis">This cmdlet returns Octopus Teams</para> </summary> <summary> <para type="description">This cmdlet returns Octopus Teams</para> </summary> <example> <code>PS C:\> Get-OctopusTeam</code> <para>Gets all the teams on the Octopus instance</para> </example> <example> <code>PS C:\> Get-OctopusTeam -name "ProjectA_Managers"</code> <para>Gets the team with the name "ProjectA_Managers"</para> </example> <example> <code>PS C:\> Get-OctopusTeam -name "ProjectA_Managers","ProjectA_Developers"</code> <para>Gets the teams with the names "ProjectA_Managers" and "ProjectA_Developers"</para> </example> <example> <code>PS C:\> Get-OctopusTeam -name "ProjectA*"</code> <para> Gets all the teams whose name starts with "ProjectA"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusTeam.TeamName"> <summary> <para type="description">Team name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusTeam.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusTenant"> <summary> <para type="Description">Gets information about Octopus Tenants</para> </summary> <summary> <para type="synopsis">Gets information about Octopus Tenants</para> </summary> <example> <code>PS C:\> Get-OctopusTenant</code> <para>Gets all the tenants of the instance</para> </example> <example> <code>PS C:\> Get-OctopusTenant -name "MyAwesomeTenant"</code> <para>Gets the tenant with the name "MyAwesometenant"</para> </example> <example> <code>PS C:\> Get-OctopusTenant -name "MyAwesomeTenant","MyOtherAwesomeTenant"</code> <para>Gets the tenants with the names "MyAwesomeTenant" and "MyOtherAwesomeTenant"</para> </example> <example> <code>PS C:\> Get-Channel -name "*AwesomeTenant"</code> <para>Gets all the tenants whose name matches the pattern "*AwesomeTenant"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusTenant.TenantName"> <summary> <para type="description">Tenant name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusTenant.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.GetOctopusUser"> <summary> <para type="synopsis">This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</para> </summary> <summary> <para type="description">This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</para> </summary> <example> <code>PS C:\> Get-OctopusUser</code> <para>Gets all the Users on the Octopus instance</para> </example> <example> <code>PS C:\> Get-OctopusUser -Username "Jotaro Kujo"</code> <para>Gets the user with the Username "Jotaro Kujo"</para> </example> <example> <code>PS C:\> Get-OctopusUser -Username "Jotaro Kujo","Dio Brando"</code> <para>Gets the users with the Usernames "Jotaro Kujo" and "Dio Brando"</para> </example> <example> <code>PS C:\> Get-OctopusUser -Username "*Joestar"</code> <para>Gets all the users whose username ends with "Joestar"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.GetOctopusUser.UserName"> <summary> <para type="description">User Name. Accepts wildcard</para> </summary> </member> <member name="P:Octoposh.Cmdlets.GetOctopusUser.ResourceOnly"> <summary> <para type="description">If set to TRUE the cmdlet will return the basic Octopur resource. If not set or set to FALSE, the cmdlet will return a human friendly Octoposh output object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.InstallOctopusTool"> <summary> <para type="synopsis">This cmdlet downloads Octo.exe from Nuget to the "Octopus Tools Folder".To learn more about this path run Get-Help Set-OctopusToolsFolder</para> <para type="synopsis">By default this cmdlet will download "Octo.exe" from "https://packages.nuget.org/api/v2". If you want to override this behavior, simply assign a different feed path/url to $env:NugetRepositoryURL</para> </summary> <summary> <para type="description">This cmdlet downloads Octo.exe from Nuget to the "Octopus Tools Folder".To learn more about this path run Get-Help Set-OctopusToolsFolder</para> <para type="description">By default this cmdlet will download "Octo.exe" from "https://packages.nuget.org/api/v2". If you want to override this behavior, simply assign a different feed path/url to $env:NugetRepositoryURL</para> </summary> <example> <code>PS C:\> Install-OctopusTool -Latest </code> <para>Downloads the latest version of Octo.exe to the Octopus Tools Folder.</para> </example> <example> <code>PS C:\> Install-OctopusTool -version 1.0.0 </code> <para>Downloads version 1.0.0 of Octo.exe to the Octopus Tools Folder.</para> </example> <example> <code>PS C:\> Install-OctopusTool -version 1.0.0 -SetAsDefault </code> <para>Downloads version 1.0.0 of Octo.exe to the Octopus Tools Folder and also sets it as the current defaul version</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.InstallOctopusTool.Version"> <summary> <para type="description">Downloads a specific version oc Octo.Exe from nuget</para> </summary> </member> <member name="P:Octoposh.Cmdlets.InstallOctopusTool.Latest"> <summary> <para type="description">Tells the cmdlet to download the latest version of Octo.exe available in Nuget</para> </summary> </member> <member name="P:Octoposh.Cmdlets.InstallOctopusTool.SetAsDefault"> <summary> <para type="description">If set to true, the cmdlet will set the just downloaded version of Octo.exe as the default one, making it instantly available using $env:Octoexe</para> </summary> </member> <member name="T:Octoposh.Cmdlets.NewOctopusConnection"> <summary> <para type="synopsis">Creates an endpoint to connect to an Octopus Server</para> </summary> <summary> <para type="description">Creates an endpoint to connect to an Octopus Server</para> </summary> <example> <code>PS C:\> $c = New-octopusconnection ; $c.repository.environments.findall()</code> <para>Gets all the environments on the Octopus instance using the Octopus .NET client repository</para> </example> <example> <code>PS C:\> $c = New-OctopusConnection ; invoke-webrequest -header $c.header -uri http://Octopus.company.com/api/environments/all -method Get </code> <para>Uses the [Header] Member of the Object returned by New-OctopusConnection as a header to call the REST API using Invoke-WebRequest and get all the Environments of the instance</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="T:Octoposh.Cmdlets.RemoveOctopusResource"> <summary> <para type="synopsis">Deletes resources from an Octopus Instance</para> </summary> <summary> <para type="description">Deletes resources from an Octopus Instance</para> </summary> <example> <code>PS C:\> $ProjectResource = Get-OctopusProject -name "MyApp" ; Remove-OctopusResource -resource $ProjectResource</code> <para>Deletes the project called "MyApp" from the Octopus Instance</para> </example> <example> <code>PS C:\> Get-OctopusProjectGroup -name "MyProjects" | select -ExpandProperty Projects | Remove-OctopusResource </code> <para>Deletes all the projects inside the Project Group "MyProjects"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.RemoveOctopusResource.Resource"> <summary> <para type="description">Resource Object to delete from the Octopus Server</para> </summary> </member> <member name="T:Octoposh.Cmdlets.NewOctopusResource"> <summary> <para type="synopsis">Creates a new Octopus Resource. This is an advanced cmdlet and all its examples involve multiple lines of code. Please check the advanced examples for a better reference: https://github.com/Dalmirog/OctoPosh/wiki/Advanced-Examples </para> </summary> <summary> <para type="description">Creates a new Octopus Resource. This is an advanced cmdlet and all its examples involve multiple lines of code. Please check the advanced examples for a better reference: https://github.com/Dalmirog/OctoPosh/wiki/Advanced-Examples </para> </summary> <example> <code>PS C:\> $pg = Get-OctopusResourceModel -Resource ProjectGroup ; $pg.name = "NewProjectGroup" ; New-OctopusResource -Resource $pg </code> <para>Creates a new Project Group called "NewProjectGroup" on Octopus</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.NewOctopusResource.Resource"> <summary> <para type="description">Resource Object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.SetOctopusConnectionInfo"> <summary> <para type="synopsis">Sets the current Octopus connection info (URL and API Key). Highly recommended to call this function from $profile to avoid having to re-configure this on every session.</para> </summary> <summary> <para type="description">Sets the current Octopus connection info (URL and API Key). Highly recommended to call this function from $profile to avoid having to re-configure this on every session.</para> </summary> <example> <code>PS C:\> Set-OctopusConnectionInfo -Server "http://MyOctopus.AwesomeCompany.com" -API "API-7CH6XN0HHOU7DDEEUGKUFUR1K"</code> <para>Set connection info with a specific API Key for an Octopus instance</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.SetOctopusConnectionInfo.Server"> <summary> <para type="description">URL of the server you want to connect to</para> </summary> </member> <member name="P:Octoposh.Cmdlets.SetOctopusConnectionInfo.ApiKey"> <summary> <para type="description">API Key you'll use to authenticate with the Octopus Server</para> </summary> </member> <member name="T:Octoposh.Cmdlets.SetOctopusReleaseStatus"> <summary> <para type="synopsis">Blocks or unblocks releases.</para> </summary> <summary> <para type="Description">Blocks or unblocks releases.</para> </summary> <example> <code>PS C:\> Set-OctopusReleaseStatus -ProjectName MyProject -ReleaseVersion 1.0.0 -state Blocked -Description "Because of reasons"</code> <para>Blocks the release [1.0.0] from the project [MyProject] from being deployed with the reason ["Because of reasons"] </para> </example> <example> <code>PS C:\> Set-OctopusReleaseStatus -ProjectName MyProject -ReleaseVersion 1.0.0, 2.0.0 -Description "Because of reasons"</code> <para>Blocks the releases [1.0.0],[2.0.0] from the project [MyProject] from being deployed with the reson ["Because of reasons"] </para> </example> <example> <code>PS C:\> Set-OctopusReleaseStatus-ProjectName MyProject -ReleaseVersion 1.0.0 -state Unblocked </code> <para>Unblocks release [1.0.0] from project [MyProject]</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.SetOctopusReleaseStatus.ProjectName"> <summary> <para type="description">Project name</para> </summary> </member> <member name="P:Octoposh.Cmdlets.SetOctopusReleaseStatus.ReleaseVersion"> <summary> <para type="description">Releases to Block/Unblock</para> </summary> </member> <member name="P:Octoposh.Cmdlets.SetOctopusReleaseStatus.Description"> <summary> <para type="description">Reason to block the deployment</para> </summary> </member> <member name="P:Octoposh.Cmdlets.SetOctopusReleaseStatus.Status"> <summary> <para type="description">Status that the release will be put into</para> </summary> </member> <member name="P:Octoposh.Cmdlets.SetOctopusReleaseStatus.Resource"> <summary> <para type="description">List of [Octopus.Model.ReleaseResource] objects that will get blocked/unblocked. By using this parameter you do not need to pass values to "ProjectName" or "ReleaseVersion", as that info will already be available in the Release object</para> </summary> </member> <member name="T:Octoposh.Cmdlets.SetOctopusToolsFolder"> <summary> <para type="synopsis">This cmdlet sets the path of the "Octopus Tools Folder". This folder is where Install-OctopusTool will download Octo.exe, and its also from where Get-OctopusToolVersion will resolve the path of the downloaded Octo.exe versions.</para> <para type="synopsis">For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder structure must be like this:</para> <para type="synopsis">["Octopus Tools Folder"]\[Child Folder]\Octo.exe</para> <para type="synopsis">For example, given the following structure:</para> <para type="synopsis">["Octopus Tools Folder"]\1.0.0\Octo.exe</para> <para type="synopsis">["Octopus Tools Folder"]\SomeFolderName\Octo.exe</para> <para type="synopsis">["Octopus Tools Folder"]\SomeFolderName\AnotherFolder\Octo.exe</para> <para type="synopsis">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"</para> </summary> <summary> <para type="description">This cmdlet sets the path of the "Octopus Tools Folder". This folder is where Install-OctopusTool will download Octo.exe, and its also from where Get-OctopusToolVersion will resolve the path of the downloaded Octo.exe versions.</para> <para type="description">For Get-OctopusToolVersion to be able to find Octo.exe version inside of the "Octopus Tools Folder", the folder structure must be like this:</para> <para type="description">["Octopus Tools Folder"]\[Child Folder]\Octo.exe</para> <para type="description">For example, given the following structure:</para> <para type="description">["Octopus Tools Folder"]\1.0.0\Octo.exe</para> <para type="description">["Octopus Tools Folder"]\SomeFolderName\Octo.exe</para> <para type="description">["Octopus Tools Folder"]\SomeFolderName\AnotherFolder\Octo.exe</para> <para type="description">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"</para> </summary> <example> <code>PS C:\> Set-OctopusToolsFolder -path C:\tools</code> <para>Sets the "Octopus Tools Folder" to "C:\Tools"</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.SetOctopusToolsFolder.Path"> <summary> <para type="description">Sets the path of the "Octopus Tools folder".</para> </summary> </member> <member name="T:Octoposh.Cmdlets.SetOctopusToolPath"> <summary> <para type="synopsis">This cmdlet sets a version of Octo.exe as default. To get the value of the current default Octo.exe version run Get-OctopusToolPath or simply use $env:OctoExe</para> <para type="synopsis">In the background [Get-OctopusToolPath] and [Set-OctopusToolPath] simply Get/Set the value of the environment variable $env:OctoExe</para> </summary> <summary> <para type="description">This cmdlet sets a version of Octo.exe as default. To get the value of the current default Octo.exe version run Get-OctopusToolPath or simply use $env:OctoExe</para> <para type="description">In the background [Get-OctopusToolPath] and [Set-OctopusToolPath] simply Get/Set the value of the environment variable $env:OctoExe</para> </summary> <example> <code>PS C:\> Set-OctopusToolPath -path C:\tools\1.0.0\Octo.exe </code> <para>Sets C:\Tools\1.0.0\Octo.exe as the current default Octo.exe version</para> </example> <example> <code>PS C:\> Set-OctopusToolPath -version 1.0.0</code> <para>Uses Get-OctopusToolVersion to look for Octo.exe version 1.0.0 and then sets its path as the current default version</para> </example> <example> <code>PS C:\>Get-OctopusToolsVersion -latest | Set-OctopusToolPath </code> <para>Gets the latest version of Octo.exe installed on the machine using Get-OctopusToolsVersion and sets $env:OctoExe with its path</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.SetOctopusToolPath.Version"> <summary> <para type="description">Sets the value of the default Octo.exe based on the version of it found by Get-OctopustoolsVersion</para> </summary> </member> <member name="P:Octoposh.Cmdlets.SetOctopusToolPath.Path"> <summary> <para type="description">Sets the value of the default Octo.exe using a literal path. The cmdlet won't validate if the path leads to an existing octo.exe file</para> </summary> </member> <member name="T:Octoposh.Cmdlets.UpdateOctopusResource"> <summary> <para type="synopsis">Updates resources from an Octopus Instance. This is an advanced cmdlet and all its examples involve multiple lines of code. Please check the advanced examples for a better reference: https://github.com/Dalmirog/OctoPosh/wiki/Advanced-Examples </para> </summary> <summary> <para type="synopsis">Updates resources from an Octopus Instance. This is an advanced cmdlet and all its examples involve multiple lines of code. Please check the advanced examples for a better reference: https://github.com/Dalmirog/OctoPosh/wiki/Advanced-Examples </para> </summary> <example> <code>PS C:\> $pg = Get-OctopusProjectGroup -name SomeProjectName ; $pg.resource.name = "SomeOtherProjectName" ; Update-OctopusResource -resource $pg.resource</code> <para> Updates the Name of a ProjectGroup </para> </example> <example> <code>PS C:\> $machine = Get-OctopusMachine -MachineName "SQL_Production" ; $machine.resource.isdisabled = $true ; Update-OctopusResource -resource $machine.resource </code> <para>Updates the [IsDisabled] property of a machine to disable it</para> </example> <para type="link" uri="http://Octoposh.net">WebSite: </para> <para type="link" uri="https://github.com/Dalmirog/OctoPosh/">Github Project: </para> <para type="link" uri="http://octoposh.readthedocs.io">Wiki: </para> <para type="link" uri="https://gitter.im/Dalmirog/OctoPosh#initial">QA and Feature requests: </para> </member> <member name="P:Octoposh.Cmdlets.UpdateOctopusResource.Resource"> <summary> <para type="description">Resource Object</para> </summary> </member> <member name="T:Octoposh.Model.OctoposhEnvVariables"> <summary> This class defines all the Environment Variables that will be used throught Octoposh, such as the one that references the folder where all the versions of Octo.exe are on, or the one that references the current Octo.exe in use. </summary> </member> <member name="F:Octoposh.Model.OctoposhEnvVariables.OctoExeEnvVariable"> <summary> Name of the variable that holds the path of the current Octo.exe version. In Powershell the equivalent would be $env:[te value of this var] like $env:OctoExe </summary> </member> <member name="F:Octoposh.Model.OctoposhEnvVariables.OctopusToolsFolderEnvVariable"> <summary> Name of the environment variable that references the directory where the folders with different versions of Octo.exe are sitting on. </summary> </member> <member name="F:Octoposh.Model.OctoposhEnvVariables.NugetRepositoryURLEnvVariable"> <summary> Nuget repository URL from where Install-OctopusTool is going to fetch the packages </summary> </member> <member name="P:Octoposh.Model.OctoposhEnvVariables.Octoexe"> <summary> Gets/Sets the value of the environment variable that references the path of an Octo.exe version </summary> </member> <member name="P:Octoposh.Model.OctoposhEnvVariables.OctopusToolsFolder"> <summary> Gets/Sets the value of the environment variable that references the directory where the folders with different versions of Octo.exe are sitting on. </summary> </member> <member name="P:Octoposh.Model.OctoposhEnvVariables.NugetRepositoryURL"> <summary> Gets/Sets the value of the environment variable that references the Nuget repository URL from where Install-OctopusTool will fetch the packages </summary> </member> <member name="T:Octoposh.Model.OctopusToolsHandler"> <summary> This class handles everything re how Octoposh deals with Octo.exe, from discovery to download from Nuget/Chocolatey </summary> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.SetToolsFolder(System.String)"> <summary> Sets the path value of the environment variable that Octoposh will use to find/download the versions of Octo.exe </summary> <param name="path">Path where the folders with the copies of Octo.exe are sitting</param> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.GetToolsFolder"> <summary> Gets the current path of the Octopus Tools Folder. </summary> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.GetAllToolVersions"> <summary> Gets all the versions of Octo.exe available in the Octopus Tools Folder. </summary> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.GetLatestToolVersion"> <summary> Gets the highest version Octo.exe available on the Octopus Tools Folder </summary> <returns></returns> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.GetToolByVersion(System.String)"> <summary> Gets a specific Octo.exe version from the Octopus Tools Folder </summary> <param name="version"></param> <exception cref="M:Octoposh.Model.OctoposhExceptions.ToolVersionNotfound(System.String)"></exception> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.SetOctoExePath(System.String)"> <summary> Sets the path of the Environment Variable that references Octo.exe </summary> <param name="path">Full path of Octo.exe</param> </member> <member name="M:Octoposh.Model.OctopusToolsHandler.GetToolPath"> <summary> Returns the current value of the environment variable that references Octo.exe </summary> <returns></returns> </member> <member name="T:Octoposh.Model.OutputConverter"> <summary> This class converts regular Octopus objects into human-friendly Octoposh objects. This class contains 1 public method per GET-* cmdlet with the same name as the cmdlet. </summary> </member> <member name="T:Octoposh.Model.ResourceCollector"> <summary> Collects Octopus resources in type-specific lists so they can be re-used during the object conversion by the OutputConverter class methods. Check OutputConverter.GetOctopusMachine() for an example of its usage. </summary> </member> </members> </doc> |