Octoposh.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-OctopusChannel --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusChannel</command:name> <command:verb>Get</command:verb> <command:noun>OctopusChannel</command:noun> <maml:description> <maml:para>Gets information about Octopus Channels</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusChannel</maml:name> <!-- Parameter: ChannelName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>ChannelName</maml:name> <maml:description> <maml:para>Channel name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ChannelName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>ChannelName</maml:name> <maml:description> <maml:para>Channel name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Channel name</maml:para> <maml:para>This is an alias of the ChannelName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project name</maml:para> <maml:para>This is an alias of the ProjectName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Channel name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusChannel, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ChannelResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusChannel</dev:code> <dev:remarks> <maml:para>Gets all the channels in all the projects of the instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusChannel -Project "MyFinantialApp"</dev:code> <dev:remarks> <maml:para>Gets all the channels of the project "MyFinantialApp"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusChannel -name "Hotfix_Website" -Project "MyFinantialApp"</dev:code> <dev:remarks> <maml:para>Gets the Channel with the name "Hotfix_Website" of the project "MyFinantialApp"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusChannel -name "Hotfix_Website","Hotfix_WebService" -Project "MyFinantialApp"</dev:code> <dev:remarks> <maml:para>Gets the Channels with the names "Hotfix_Website" and "Hotfix_WebService" of the project "MyFinantialApp"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-OctopusChannel -name "Hotfix_*" -Project "MyFinantialApp"</dev:code> <dev:remarks> <maml:para>Gets all the Channels whose name starts with "Hotfix_" of the project "MyFinantialApp"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-OctopusConnection --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-OctopusConnection</command:name> <command:verb>New</command:verb> <command:noun>OctopusConnection</command:noun> <maml:description> <maml:para>Creates an endpoint to connect to an Octopus Server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates an endpoint to connect to an Octopus Server</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: OctopusConnection --> <command:returnValue> <dev:type> <maml:name>Octoposh.Model.OctopusConnection</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $c = New-octopusconnection ; $c.repository.environments.findall()</dev:code> <dev:remarks> <maml:para>Gets all the environments on the Octopus instance using the Octopus .NET client repository</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $c = New-OctopusConnection ; invoke-webrequest -header $c.header -uri http://Octopus.company.com/api/environments/all -method Get </dev:code> <dev:remarks> <maml: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</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusConnectionInfo --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusConnectionInfo</command:name> <command:verb>Get</command:verb> <command:noun>OctopusConnectionInfo</command:noun> <maml:description> <maml:para>This function gets the data of the variables $env:OctopusURI and $env:OctopusAPI that are used by all the cmdlets of the Octoposh module</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function gets the data of the variables $env:OctopusURI and $env:OctopusAPI that are used by all the cmdlets of the Octoposh module</maml:para> </maml:description> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: OctopusConnectionInfo --> <command:returnValue> <dev:type> <maml:name>Octoposh.Model.OctopusConnectionInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusConnectionInfo</dev:code> <dev:remarks> <maml:para>Get the current connection info. Its the same as getting the values of $env:OctopusURL and $Env:OctopusAPIKey</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-OctopusConnectionInfo --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-OctopusConnectionInfo</command:name> <command:verb>Set</command:verb> <command:noun>OctopusConnectionInfo</command:noun> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-OctopusConnectionInfo</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="URL"> <maml:name>Server</maml:name> <maml:description> <maml:para>URL of the server you want to connect to</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API Key you'll use to authenticate with the Octopus Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="URL"> <maml:name>Server</maml:name> <maml:description> <maml:para>URL of the server you want to connect to</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="URL"> <maml:name>URL</maml:name> <maml:description> <maml:para>URL of the server you want to connect to</maml:para> <maml:para>This is an alias of the Server parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiKey --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>API Key you'll use to authenticate with the Octopus Server</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>URL of the server you want to connect to</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>API Key you'll use to authenticate with the Octopus Server</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-OctopusConnectionInfo -Server "http://MyOctopus.AwesomeCompany.com" -API "API-7CH6XN0HHOU7DDEEUGKUFUR1K"</dev:code> <dev:remarks> <maml:para>Set connection info with a specific API Key for an Octopus instance</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusDashboard --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusDashboard</command:name> <command:verb>Get</command:verb> <command:noun>OctopusDashboard</command:noun> <maml:description> <maml:para>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.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusDashboard</maml:name> <!-- Parameter: DeploymentStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeploymentStatus</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Project to filter for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of the Project to filter for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of the Project to filter for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Project to filter for.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DeploymentStatus --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeploymentStatus</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusDashboardEntry, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-OctopusConnectionInfo -Server "http://MyOctopus.AwesomeCompany.com" -API "API-7CH6XN0HHOU7DDEEUGKUFUR1K"</dev:code> <dev:remarks> <maml:para>Set connection info with a specific API Key for an Octopus instance</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusDeployment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusDeployment</command:name> <command:verb>Get</command:verb> <command:noun>OctopusDeployment</command:noun> <maml:description> <maml:para>Gets information about Octopus deployments</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about Octopus deployments</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByVersion --> <command:syntaxItem> <maml:name>Get-OctopusDeployment</maml:name> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM +00:00</dev:defaultValue> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM +00:00</dev:defaultValue> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of the Project to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReleaseVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Version,Release"> <maml:name>ReleaseVersion</maml:name> <maml:description> <maml:para>Release version to filter by. The cmdlet will only return deployments that belong to these releases</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByLatest --> <command:syntaxItem> <maml:name>Get-OctopusDeployment</maml:name> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM +00:00</dev:defaultValue> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM +00:00</dev:defaultValue> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LatestReleases --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Latest"> <maml:name>LatestReleases</maml:name> <maml:description> <maml:para>Gets deployments by latest X releases</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of the Project to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ReleaseVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Version,Release"> <maml:name>ReleaseVersion</maml:name> <maml:description> <maml:para>Release version to filter by. The cmdlet will only return deployments that belong to these releases</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Version,Release"> <maml:name>Version</maml:name> <maml:description> <maml:para>Release version to filter by. The cmdlet will only return deployments that belong to these releases</maml:para> <maml:para>This is an alias of the ReleaseVersion parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Version,Release"> <maml:name>Release</maml:name> <maml:description> <maml:para>Release version to filter by. The cmdlet will only return deployments that belong to these releases</maml:para> <maml:para>This is an alias of the ReleaseVersion parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LatestReleases --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Latest"> <maml:name>LatestReleases</maml:name> <maml:description> <maml:para>Gets deployments by latest X releases</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="Latest"> <maml:name>Latest</maml:name> <maml:description> <maml:para>Gets deployments by latest X releases</maml:para> <maml:para>This is an alias of the LatestReleases parameter.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>30</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> <maml:para>This is an alias of the EnvironmentName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of the Project to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Project"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the Project to filter by</maml:para> <maml:para>This is an alias of the ProjectName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Before --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Before</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>12/31/9999 11:59:59 PM +00:00</dev:defaultValue> </command:parameter> <!-- Parameter: After --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>After</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">DateTimeOffset</command:parameterValue> <dev:type> <maml:name>System.DateTimeOffset</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1/1/0001 12:00:00 AM +00:00</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the Project to filter by</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusDeployment, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.DeploymentResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusDeployment</dev:code> <dev:remarks> <maml: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.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusDeployment -Project "MyProject" -ReleaseVersion 1.0.0</dev:code> <dev:remarks> <maml:para>Get all the deployments that were done for the release 1.0.0 of the project "MyProject"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusDeployment -EnvironmentName "Staging","UAT" -ProjectName "MyService"</dev:code> <dev:remarks> <maml:para>Get all the deployents that were done to the environments Staging and UAT on the project "MyService"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusDeployment -project "MyProduct.Webapp","MyProduct.service" -Environment "Production"</dev:code> <dev:remarks> <maml:para>Get all the deployments that were done to the environment "Production" on the projects "MyProduct.webapp" and "MyProduct.service"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS Get-OctopusDeployment -project "MyProduct.Webapp" -Environment "Production" -After 2/20/2015 -Before 2/21/2015</dev:code> <dev:remarks> <maml:para>Gets all the machines registered in "Listening" mode. "Polling" is also a valid value</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusEnvironment --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>OctopusEnvironment</command:noun> <maml:description> <maml:para>Gets information about Octopus Environments</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about Octopus Environments</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-OctopusEnvironment</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Environment name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Environment name</maml:para> <maml:para>This is an alias of the EnvironmentName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Environment name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusEnvironment, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.EnvironmentResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusEnvironment -name Production</dev:code> <dev:remarks> <maml:para>Gets info about the environment "Production"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusEnvironment -name "FeatureTest*"</dev:code> <dev:remarks> <maml:para>Gets info about all the environments whose name matches the pattern "FeatureTest*"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusFeed --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusFeed</command:name> <command:verb>Get</command:verb> <command:noun>OctopusFeed</command:noun> <maml:description> <maml:para>Gets information about the external feeds registered in Octopus</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about the external feeds registered in Octopus</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-OctopusFeed</maml:name> <!-- Parameter: FeedName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>FeedName</maml:name> <maml:description> <maml:para>Feed name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByURL --> <command:syntaxItem> <maml:name>Get-OctopusFeed</maml:name> <!-- Parameter: URL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="URI"> <maml:name>URL</maml:name> <maml:description> <maml:para>Feed URL/Path</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FeedName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>FeedName</maml:name> <maml:description> <maml:para>Feed name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Feed name</maml:para> <maml:para>This is an alias of the FeedName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="URI"> <maml:name>URL</maml:name> <maml:description> <maml:para>Feed URL/Path</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="URI"> <maml:name>URI</maml:name> <maml:description> <maml:para>Feed URL/Path</maml:para> <maml:para>This is an alias of the URL parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Feed name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Feed URL/Path</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusFeed, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.FeedResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusFeed</dev:code> <dev:remarks> <maml:para>Get all the external feeds registered in the current Instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusFeed -FeedName "MyGet"</dev:code> <dev:remarks> <maml:para>Get the External Feed named "MyGet"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusFeed -URL "*Mycompany*"</dev:code> <dev:remarks> <maml:para>Get a feed with a the string "MyCompany" inside its URL</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusLifecycle --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusLifecycle</command:name> <command:verb>Get</command:verb> <command:noun>OctopusLifecycle</command:noun> <maml:description> <maml:para>This cmdlet returns information about Octopus Lifecycles</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns information about Octopus Lifecycles</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusLifecycle</maml:name> <!-- Parameter: LifecycleName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>LifecycleName</maml:name> <maml:description> <maml:para>Lifecycle name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LifecycleName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>LifecycleName</maml:name> <maml:description> <maml:para>Lifecycle name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Lifecycle name</maml:para> <maml:para>This is an alias of the LifecycleName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Lifecycle name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusLifecycle, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.LifecycleResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusLifecycle</dev:code> <dev:remarks> <maml:para>Get all the Lifecycles of the current Instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusLifecycle -name MyLifecycle</dev:code> <dev:remarks> <maml:para>Get the Lifecycle named "MyLifecycle"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusLifecycle -name "ProjectA_Lifecycle","ProjectB_Lifecycle"</dev:code> <dev:remarks> <maml:para>Gets the teams with the names "ProjectA_Lifecycle" and "ProjectB_Lifecycle"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusLifecycle -name "ProjectA*"</dev:code> <dev:remarks> <maml:para>Gets all the lifecycles whose name starts with "ProjectA"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusMachine --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusMachine</command:name> <command:verb>Get</command:verb> <command:noun>OctopusMachine</command:noun> <maml:description> <maml:para>This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-OctopusMachine</maml:name> <!-- Parameter: MachineName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Name of the Machine to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByEnvironment --> <command:syntaxItem> <maml:name>Get-OctopusMachine</maml:name> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByURL --> <command:syntaxItem> <maml:name>Get-OctopusMachine</maml:name> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: URL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="URI"> <maml:name>URL</maml:name> <maml:description> <maml:para>Target URI to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByCommunicationStyle --> <command:syntaxItem> <maml:name>Get-OctopusMachine</maml:name> <!-- Parameter: CommunicationStyle --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Mode"> <maml:name>CommunicationStyle</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: MachineName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>Name of the Machine to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the Machine to filter by</maml:para> <maml:para>This is an alias of the MachineName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: EnvironmentName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>EnvironmentName</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Environment"> <maml:name>Environment</maml:name> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> <maml:para>This is an alias of the EnvironmentName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: URL --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="URI"> <maml:name>URL</maml:name> <maml:description> <maml:para>Target URI to filter by</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="URI"> <maml:name>URI</maml:name> <maml:description> <maml:para>Target URI to filter by</maml:para> <maml:para>This is an alias of the URL parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CommunicationStyle --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Mode"> <maml:name>CommunicationStyle</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="Mode"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Target communication style to filter by</maml:para> <maml:para>This is an alias of the CommunicationStyle parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the Machine to filter by</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of the Environment to filter by</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target URI to filter by</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Target communication style to filter by</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusMachine, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.MachineResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusMachine -name "Database_Prod"</dev:code> <dev:remarks> <maml:para>Gets the machine with the name "Database_Prod"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusMachine -name "*_Prod"</dev:code> <dev:remarks> <maml:para>Gets all the machines which name is like "*_Prod"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusMachine -EnvironmentName "Staging","UAT""</dev:code> <dev:remarks> <maml:para>Gets all the machines on the environments "Staging","UAT"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusMachine -URL "*:10933"</dev:code> <dev:remarks> <maml:para>Gets all the machines with the string "*:10933" at the end of the URL</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS Get-OctopusMachine -Mode Listening</dev:code> <dev:remarks> <maml:para>Gets all the machines registered in "Listening" mode. "Polling" is also a valid value</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusProject --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusProject</command:name> <command:verb>Get</command:verb> <command:noun>OctopusProject</command:noun> <maml:description> <maml:para>This cmdlet returns info about Octopus Projects</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns info about Octopus Projects</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-OctopusProject</maml:name> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByProjectGroup --> <command:syntaxItem> <maml:name>Get-OctopusProject</maml:name> <!-- Parameter: ProjectGroupName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="ProjectGroup"> <maml:name>ProjectGroupName</maml:name> <maml:description> <maml:para>Gets all projects inside a set of Project Groups</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Project name</maml:para> <maml:para>This is an alias of the ProjectName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectGroupName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="ProjectGroup"> <maml:name>ProjectGroupName</maml:name> <maml:description> <maml:para>Gets all projects inside a set of Project Groups</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="ProjectGroup"> <maml:name>ProjectGroup</maml:name> <maml:description> <maml:para>Gets all projects inside a set of Project Groups</maml:para> <maml:para>This is an alias of the ProjectGroupName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Gets all projects inside a set of Project Groups</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusProject, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ProjectResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProject</dev:code> <dev:remarks> <maml:para>Gets all the projects of the current Instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProject -name MyProject</dev:code> <dev:remarks> <maml:para>Get the project named "MyProject"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProject -name MyApp*</dev:code> <dev:remarks> <maml:para>Get all the projects whose name starts with the string "MyApp"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProject -ProjectGroupName "MyProduct"</dev:code> <dev:remarks> <maml:para>Gets all the projects inside of the Project Group "MyProduct"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusProjectGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusProjectGroup</command:name> <command:verb>Get</command:verb> <command:noun>OctopusProjectGroup</command:noun> <maml:description> <maml:para>Gets information about Octopus Project Groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about Octopus Project Groups</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-OctopusProjectGroup</maml:name> <!-- Parameter: ProjectGroupName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>ProjectGroupName</maml:name> <maml:description> <maml:para>Project Group name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProjectGroupName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>ProjectGroupName</maml:name> <maml:description> <maml:para>Project Group name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Project Group name</maml:para> <maml:para>This is an alias of the ProjectGroupName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project Group name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusProjectGroup, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ProjectGroupResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProjectGroup</dev:code> <dev:remarks> <maml:para>Gets all the Project Groups on the Octopus instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProjectGroup -name "MyProjects"</dev:code> <dev:remarks> <maml:para>Gets a Project Group named "MyProjects"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProjectGroup -name "*web*"</dev:code> <dev:remarks> <maml:para>Get all the projects whose name matches the pattern "*web*"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusRelease --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusRelease</command:name> <command:verb>Get</command:verb> <command:noun>OctopusRelease</command:noun> <maml:description> <maml:para>Gets information about Octopus Releases</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information about Octopus Releases</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByVersion --> <command:syntaxItem> <maml:name>Get-OctopusRelease</maml:name> <!-- Parameter: ProjectName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of project to filter releases. Only one Project can be passed to this parameter at a time</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReleaseVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="Version,Release"> <maml:name>ReleaseVersion</maml:name> <maml:description> <maml:para>Release version number</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByLatest --> <command:syntaxItem> <maml:name>Get-OctopusRelease</maml:name> <!-- Parameter: ProjectName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of project to filter releases. Only one Project can be passed to this parameter at a time</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Latest --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Latest</maml:name> <maml:description> <maml:para>Get latest X releases</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ReleaseVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="Version,Release"> <maml:name>ReleaseVersion</maml:name> <maml:description> <maml:para>Release version number</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="Version,Release"> <maml:name>Version</maml:name> <maml:description> <maml:para>Release version number</maml:para> <maml:para>This is an alias of the ReleaseVersion parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="2" aliases="Version,Release"> <maml:name>Release</maml:name> <maml:description> <maml:para>Release version number</maml:para> <maml:para>This is an alias of the ReleaseVersion parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Name of project to filter releases. Only one Project can be passed to this parameter at a time</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Project"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of project to filter releases. Only one Project can be passed to this parameter at a time</maml:para> <maml:para>This is an alias of the ProjectName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Latest --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Latest</maml:name> <maml:description> <maml:para>Get latest X releases</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Name of project to filter releases. Only one Project can be passed to this parameter at a time</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusRelease, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ReleaseResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusRelease -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Get all the realeases of the project "MyProject"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusRelease -ProjectName "MyProject" -version 1.0.1,1.0.2</dev:code> <dev:remarks> <maml:para>Get the release realeases 1.0.1 & 1.0.2 of the project "MyProject"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusRelease -ProjectName "MyProject" -Latest 10</dev:code> <dev:remarks> <maml:para>Get the latest 10 releases of the project "MyProject"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Set-OctopusReleaseStatus --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-OctopusReleaseStatus</command:name> <command:verb>Set</command:verb> <command:noun>OctopusReleaseStatus</command:noun> </command:details> <command:syntax> <!-- Parameter set: ByProjectAndVersion --> <command:syntaxItem> <maml:name>Set-OctopusReleaseStatus</maml:name> <!-- Parameter: ReleaseVersion --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReleaseVersion</maml:name> <maml:description> <maml:para>Releases to Block/Unblock</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="State"> <maml:name>Status</maml:name> <maml:description> <maml:para>Status that the release will be put into</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3" aliases="Reason"> <maml:name>Description</maml:name> <maml:description> <maml:para>Reason to block the deployment</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: ByReleaseResource --> <command:syntaxItem> <maml:name>Set-OctopusReleaseStatus</maml:name> <!-- Parameter: Resource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ReleaseResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="State"> <maml:name>Status</maml:name> <maml:description> <maml:para>Status that the release will be put into</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3" aliases="Reason"> <maml:name>Description</maml:name> <maml:description> <maml:para>Reason to block the deployment</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ProjectName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ReleaseVersion --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ReleaseVersion</maml:name> <maml:description> <maml:para>Releases to Block/Unblock</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3" aliases="Reason"> <maml:name>Description</maml:name> <maml:description> <maml:para>Reason to block the deployment</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" position="3" aliases="Reason"> <maml:name>Reason</maml:name> <maml:description> <maml:para>Reason to block the deployment</maml:para> <maml:para>This is an alias of the Description parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Status --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="State"> <maml:name>Status</maml:name> <maml:description> <maml:para>Status that the release will be put into</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="2" aliases="State"> <maml:name>State</maml:name> <maml:description> <maml:para>Status that the release will be put into</maml:para> <maml:para>This is an alias of the Status parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">List`1</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ReleaseResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Releases to Block/Unblock</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.ReleaseResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>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</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Set-OctopusReleaseStatus -ProjectName MyProject -ReleaseVersion 1.0.0 -Description "Because of reasons"</dev:code> <dev:remarks> <maml:para>Blocks the release [1.0.0] from the project [MyProject] from being deployed with the reson ["Because of reasons"]. Using the "ProjectName" parameter allows you to only block releases in one project at a time. For multiple releases check usage of parameter "Resource"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Set-OctopusReleaseStatus -ProjectName MyProject -ReleaseVersion 1.0.0, 2.0.0 -Description "Because of reasons"</dev:code> <dev:remarks> <maml:para>Blocks the releasse [1.0.0],[2.0.0] from the project [MyProject] from being deployed with the reson ["Because of reasons"]. Using the "ProjectName" parameter allows you to only block releases in one project at a time. For multiple releases check usage of parameter "Resource"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Set-OctopusReleaseStatus -Resource $ReleaseResource -Description </dev:code> <dev:remarks> <maml:para>Blocks all the releases</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: New-OctopusResource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>New-OctopusResource</command:name> <command:verb>New</command:verb> <command:noun>OctopusResource</command:noun> <maml:description> <maml:para>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</maml:para> </maml:description> </command:details> <maml:description> <maml:para>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</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>New-OctopusResource</maml:name> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource Object</maml:para> </maml:description> <command:parameterValue required="true">Resource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Resource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource Object</maml:para> </maml:description> <command:parameterValue required="true">Resource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Resource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.Resource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ChannelResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ChannelResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: EnvironmentResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.EnvironmentResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LibraryVariableSetResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.LibraryVariableSetResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LifecycleResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.LifecycleResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: MachineResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.MachineResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: NuGetFeedResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.NuGetFeedResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ProjectGroupResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ProjectGroupResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ProjectResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ProjectResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TagSetResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TagSetResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TeamResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TeamResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TenantResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TenantResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: UserResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.UserResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $pg = Get-OctopusResourceModel -Resource ProjectGroup ; $pg.name = "NewProjectGroup" ; New-OctopusResource -Resource $pg </dev:code> <dev:remarks> <maml:para>Creates a new Project Group called "NewProjectGroup" on Octopus</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-OctopusResource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-OctopusResource</command:name> <command:verb>Remove</command:verb> <command:noun>OctopusResource</command:noun> <maml:description> <maml:para>Deletes resources from an Octopus Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes resources from an Octopus Instance</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-OctopusResource</maml:name> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource Object to delete from the Octopus Server</maml:para> </maml:description> <command:parameterValue required="true">Resource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Resource[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource Object to delete from the Octopus Server</maml:para> </maml:description> <command:parameterValue required="true">Resource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Resource[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.Resource[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource Object to delete from the Octopus Server</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Boolean --> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $ProjectResource = Get-OctopusProject -name "MyApp" ; Remove-OctopusResource -resource $ProjectResource</dev:code> <dev:remarks> <maml:para>Deletes the project called "MyApp" from the Octopus Instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusProjectGroup -name "MyProjects" | select -ExpandProperty Projects | Remove-OctopusResource </dev:code> <dev:remarks> <maml:para>Deletes all the projects inside the Project Group "MyProjects"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Update-OctopusResource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Update-OctopusResource</command:name> <command:verb>Update</command:verb> <command:noun>OctopusResource</command:noun> <maml:description> <maml:para>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</maml:para> <maml:para>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</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Update-OctopusResource</maml:name> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource Object</maml:para> </maml:description> <command:parameterValue required="true">Resource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Resource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource Object</maml:para> </maml:description> <command:parameterValue required="true">Resource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Resource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.Resource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Resource Object</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ChannelResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ChannelResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: EnvironmentResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.EnvironmentResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LibraryVariableSetResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.LibraryVariableSetResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LifecycleResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.LifecycleResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: MachineResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.MachineResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: NuGetFeedResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.NuGetFeedResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ProjectGroupResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ProjectGroupResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ProjectResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ProjectResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TagSetResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TagSetResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TeamResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TeamResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TenantResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TenantResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: UserResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.UserResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $pg = Get-OctopusProjectGroup -name SomeProjectName ; $pg.resource.name = "SomeOtherProjectName" ; Update-OctopusResource -resource $pg.resource</dev:code> <dev:remarks> <maml:para>Updates the Name of a ProjectGroup</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> $machine = Get-OctopusMachine -MachineName "SQL_Production" ; $machine.resource.isdisabled = $true ; Update-OctopusResource -resource $machine.resource </dev:code> <dev:remarks> <maml:para>Updates the [IsDisabled] property of a machine to disable it</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusResourceModel --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusResourceModel</command:name> <command:verb>Get</command:verb> <command:noun>OctopusResourceModel</command:noun> <maml:description> <maml:para>This cmdlet creates instances of Octopus Resource Objects</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusResourceModel</maml:name> <!-- Parameter: Resource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object model</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Resource --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Resource object model</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ChannelResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ChannelResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: EnvironmentResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.EnvironmentResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LibraryVariableSetResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.LibraryVariableSetResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LifecycleResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.LifecycleResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: MachineResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.MachineResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: NuGetFeedResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.NuGetFeedResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ProjectGroupResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ProjectGroupResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ProjectResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.ProjectResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TagSetResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TagSetResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TeamResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TeamResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: TenantResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.TenantResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: UserResource --> <command:returnValue> <dev:type> <maml:name>Octopus.Client.Model.UserResource</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> $EnvironmentObj = Get-OctopusResourceModel -Resource Environment</dev:code> <dev:remarks> <maml:para>Creates an Environment Resource object</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusServerThumbprint --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusServerThumbprint</command:name> <command:verb>Get</command:verb> <command:noun>OctopusServerThumbprint</command:noun> <maml:description> <maml:para>Gets the Octopus Server thumbprint. Admin access in the Octopus instance will be needed for this to work</maml:para> <maml:para>Gets the Octopus Server thumbprint. Admin access in the Octopus instance will be needed for this to work</maml:para> </maml:description> </command:details> <command:syntax /> <command:parameters /> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusServerThumbprint</dev:code> <dev:remarks> <maml:para>Gets the thumbprint of the Octopus Server</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusTagSet --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusTagSet</command:name> <command:verb>Get</command:verb> <command:noun>OctopusTagSet</command:noun> <maml:description> <maml:para>Gets information about Octopus TagSets</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusTagSet</maml:name> <!-- Parameter: TagSetName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>TagSet name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TagSetName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>TagSetName</maml:name> <maml:description> <maml:para>TagSet name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>TagSet name</maml:para> <maml:para>This is an alias of the TagSetName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>TagSet name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusTagSet, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.TagSetResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTagSet</dev:code> <dev:remarks> <maml:para>Gets all the TagSets of the instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTagSet -name "Upgrade Ring"</dev:code> <dev:remarks> <maml:para>Gets the TagSet with the name "Upgrade Ring"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTagSet -name "Upgrade Ring","EAP"</dev:code> <dev:remarks> <maml:para>Gets the TagSets with the names "Upgrade Ring" and "EAP"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopustagSet -name "*_Customers"</dev:code> <dev:remarks> <maml:para>Gets all the TagSets whose name matches the pattern "*_Customers"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusTeam --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusTeam</command:name> <command:verb>Get</command:verb> <command:noun>OctopusTeam</command:noun> <maml:description> <maml:para>This cmdlet returns Octopus Teams</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns Octopus Teams</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusTeam</maml:name> <!-- Parameter: TeamName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>TeamName</maml:name> <maml:description> <maml:para>Team name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TeamName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>TeamName</maml:name> <maml:description> <maml:para>Team name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Team name</maml:para> <maml:para>This is an alias of the TeamName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Team name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusTeam, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.TeamResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTeam</dev:code> <dev:remarks> <maml:para>Gets all the teams on the Octopus instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTeam -name "ProjectA_Managers"</dev:code> <dev:remarks> <maml:para>Gets the team with the name "ProjectA_Managers"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTeam -name "ProjectA_Managers","ProjectA_Developers"</dev:code> <dev:remarks> <maml:para>Gets the teams with the names "ProjectA_Managers" and "ProjectA_Developers"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTeam -name "ProjectA*"</dev:code> <dev:remarks> <maml:para>Gets all the teams whose name starts with "ProjectA"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusTenant --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusTenant</command:name> <command:verb>Get</command:verb> <command:noun>OctopusTenant</command:noun> <maml:description> <maml:para>Gets information about Octopus Tenants</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusTenant</maml:name> <!-- Parameter: TenantName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>TenantName</maml:name> <maml:description> <maml:para>Tenant name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TenantName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>TenantName</maml:name> <maml:description> <maml:para>Tenant name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>Tenant name</maml:para> <maml:para>This is an alias of the TenantName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Tenant name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusTenant, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.TenantResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTenant</dev:code> <dev:remarks> <maml:para>Gets all the tenants of the instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTenant -name "MyAwesomeTenant"</dev:code> <dev:remarks> <maml:para>Gets the tenant with the name "MyAwesometenant"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusTenant -name "MyAwesomeTenant","MyOtherAwesomeTenant"</dev:code> <dev:remarks> <maml:para>Gets the tenants with the names "MyAwesomeTenant" and "MyOtherAwesomeTenant"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-Channel -name "*AwesomeTenant"</dev:code> <dev:remarks> <maml:para>Gets all the tenants whose name matches the pattern "*AwesomeTenant"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusUser --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusUser</command:name> <command:verb>Get</command:verb> <command:noun>OctopusUser</command:noun> <maml:description> <maml:para>This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns info about Octopus Targets (Tentacles, cloud regions, Offline deployment targets, SHH)</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusUser</maml:name> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User Name. Accepts wildcard</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: UserName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>UserName</maml:name> <maml:description> <maml:para>User Name. Accepts wildcard</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="Name"> <maml:name>Name</maml:name> <maml:description> <maml:para>User Name. Accepts wildcard</maml:para> <maml:para>This is an alias of the UserName parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>User Name. Accepts wildcard</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusMachine, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.MachineResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusUser</dev:code> <dev:remarks> <maml:para>Gets all the Users on the Octopus instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusUser -Username "Jotaro Kujo"</dev:code> <dev:remarks> <maml:para>Gets the user with the Username "Jotaro Kujo"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusUser -Username "Jotaro Kujo","Dio Brando"</dev:code> <dev:remarks> <maml:para>Gets the users with the Usernames "Jotaro Kujo" and "Dio Brando"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusUser -Username "*Joestar"</dev:code> <dev:remarks> <maml:para>Gets all the users whose username ends with "Joestar"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-OctopusVariableSet --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-OctopusVariableSet</command:name> <command:verb>Get</command:verb> <command:noun>OctopusVariableSet</command:noun> <maml:description> <maml:para>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.</maml:para> <maml:para>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.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-OctopusVariableSet</maml:name> <!-- Parameter: LibrarySetName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>LibrarySetName</maml:name> <maml:description> <maml:para>Library Set name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeUsage</maml:name> <maml:description> <maml:para>If set to TRUE the list of Projects on which each Library Variable Set is being used will be displayer</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: LibrarySetName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>LibrarySetName</maml:name> <maml:description> <maml:para>Library Set name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProjectName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IncludeUsage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeUsage</maml:name> <maml:description> <maml:para>If set to TRUE the list of Projects on which each Library Variable Set is being used will be displayer</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceOnly</maml:name> <maml:description> <maml:para>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</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Library Set name</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Project name</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusVariableSet, Octoposh, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: List`1 --> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Octopus.Client.Model.VariableSetResource, Octopus.Client, Version=4.5.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet</dev:code> <dev:remarks> <maml:para>Gets all the Project and Library variable sets of the instance</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_SC"</dev:code> <dev:remarks> <maml:para>Gets the Variable Set of the Library Variable Set with the name "Stands_SC"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_SC" -IncludeUsage</dev:code> <dev:remarks> <maml: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</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 4 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_SC","Stands_DII"</dev:code> <dev:remarks> <maml:para>Gets the LibraryVariableSets with the names "Stands_SC" and "Stands_DII"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 5 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_*"</dev:code> <dev:remarks> <maml:para>Gets all the LibraryVariableSets whose name matches the pattern "Stands_*"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 6 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -LibrarySetName "Stands_*" -IncludeLibrarySetUsage </dev:code> <dev:remarks> <maml: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</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 7 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -ProjectName "Website_Stardust","Website_Diamond"</dev:code> <dev:remarks> <maml:para>Gets the Variable Sets of the Projects "Website_Stardust" and "Website_Diamond"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 8 ----------</maml:title> <dev:code>PS C:\> Get-OctopusVariableSet -ProjectName "Website_Stardust" -LibrarySetName "Stands_SC"</dev:code> <dev:remarks> <maml:para>Gets the Variable Sets of the Project "Website_Stardust" and the Library variable set "Stands_SC"</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>WebSite: </maml:linkText> <maml:uri>http://Octoposh.net</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Github Project: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Wiki: </maml:linkText> <maml:uri>https://github.com/Dalmirog/OctoPosh/wiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>QA and Feature requests: </maml:linkText> <maml:uri>https://gitter.im/Dalmirog/OctoPosh#initial</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |