en-US/Octopus-Cmdlets.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-Action --> <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-Action</command:name> <command:verb>Get</command:verb> <command:noun>Action</command:noun> <maml:description> <maml:para>Get an action role from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoAction cmdlet gets an action from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Action</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the action 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the action to retrieve.</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: ById --> <command:syntaxItem> <maml:name>Get-Action</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the action 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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the action to retrieve.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the action 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the action to retrieve.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the action to retrieve.</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>The name of the action to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octoaction Project</dev:code> <dev:remarks> <maml:para>Get all the actions in the project named 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-Channel --> <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>Copy-Channel</command:name> <command:verb>Copy</command:verb> <command:noun>Channel</command:noun> <maml:description> <maml:para>Copy a channel in an Octopus Deploy project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoCopyChannel cmdlet copies a channel in an Octopus Deploy project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-Channel</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project containing the channel to copy.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the channel to copy.</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: Destination --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The name of the new channel.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project containing the channel to copy.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the channel to copy.</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: Destination --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The name of the new channel.</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>The name of the channel to copy.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>copy-octochannel Example Website</dev:code> <dev:remarks> <maml:para>Make a copy the channel named 'Priority' in the project named 'Example'. Since no destination argument was specified, the new channel will be named 'Priority - Copy'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Deployment --> <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-Deployment</command:name> <command:verb>Get</command:verb> <command:noun>Deployment</command:noun> <maml:description> <maml:para>Get a deployment from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoDeployment cmdlet gets a deployment from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByProject --> <command:syntaxItem> <maml:name>Get-Deployment</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to get deployments 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: Release --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Release</maml:name> <maml:description> <maml:para>The name of the release to get deployments 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> <!-- Parameter set: ByRelease --> <command:syntaxItem> <maml:name>Get-Deployment</maml:name> <!-- Parameter: ReleaseId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The id of the release to get deployments 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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to get deployments 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: Release --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Release</maml:name> <maml:description> <maml:para>The name of the release to get deployments 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: ReleaseId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The id of the release to get deployments 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:parameters> <command:inputTypes /> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octodeployment Project v1.0.1</dev:code> <dev:remarks> <maml:para>Get all the deployments of the release 'v1.01.' for the project named 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-DeploymentProcess --> <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-DeploymentProcess</command:name> <command:verb>Get</command:verb> <command:noun>DeploymentProcess</command:noun> <maml:description> <maml:para>Get a deployment process from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoDeploymentProcess cmdlet gets a deployment process from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByProjectName --> <command:syntaxItem> <maml:name>Get-DeploymentProcess</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to retrieve the process 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> <!-- Parameter set: ById --> <command:syntaxItem> <maml:name>Get-DeploymentProcess</maml:name> <!-- Parameter: DeploymentProcessId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DeploymentProcessId</maml:name> <maml:description> <maml:para>The id of the deployment process to retrieve.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to retrieve the process 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: DeploymentProcessId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>DeploymentProcessId</maml:name> <maml:description> <maml:para>The id of the deployment process to retrieve.</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>The id of the deployment process to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octodeploymentprocess Project</dev:code> <dev:remarks> <maml:para>Get the deployment process for the project 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-Environment --> <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>Add-Environment</command:name> <command:verb>Add</command:verb> <command:noun>Environment</command:noun> <maml:description> <maml:para>Add a new environment to the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoEnvironment cmdlet adds a new environment to the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-Environment</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to create.</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="true (ByPropertyName)" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the environment to create.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to create.</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="true (ByPropertyName)" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the environment to create.</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>The name of the environment to create.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octoenvironment DEV</dev:code> <dev:remarks> <maml:para>Add a new environment named 'DEV'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>add-octoenvironment -Name DEV -Description "Our development environment"</dev:code> <dev:remarks> <maml:para>Add a new environment named 'DEV' with a description.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Environment --> <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-Environment</command:name> <command:verb>Get</command:verb> <command:noun>Environment</command:noun> <maml:description> <maml:para>Gets the environments in the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoEnvironment cmdlet gets the environments in the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Environment</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Determines whether to temporarily cache the results or not.</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: ById --> <command:syntaxItem> <maml:name>Get-Environment</maml:name> <!-- Parameter: EnvironmentId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EnvironmentId</maml:name> <maml:description> <maml:para>The id of the environment to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Determines whether to temporarily cache the results or not.</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: ByScope --> <command:syntaxItem> <maml:name>Get-Environment</maml:name> <!-- Parameter: ScopeValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScopeValue</maml:name> <maml:description> <maml:para>The environment to retrieve by ScopeValue.</maml:para> </maml:description> <command:parameterValue required="true">ScopeValue</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.ScopeValue</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Determines whether to temporarily cache the results or not.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to retrieve.</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: EnvironmentId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>EnvironmentId</maml:name> <maml:description> <maml:para>The id of the environment to retrieve.</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: ScopeValue --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ScopeValue</maml:name> <maml:description> <maml:para>The environment to retrieve by ScopeValue.</maml:para> </maml:description> <command:parameterValue required="true">ScopeValue</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.ScopeValue</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Determines whether to temporarily cache the results or not.</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>The name of the environment to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octoenvironment</dev:code> <dev:remarks> <maml:para>This command gets all the environments.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-Environment --> <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-Environment</command:name> <command:verb>Remove</command:verb> <command:noun>Environment</command:noun> <maml:description> <maml:para>Remove an environment from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OctoEnvironment cmdlet removes an environment from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-Environment</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to remove.</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: ById --> <command:syntaxItem> <maml:name>Remove-Environment</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the environment to remove.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the environment to remove.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the environment to remove.</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>The name of the environment to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>remove-octoenvironment DEV</dev:code> <dev:remarks> <maml:para>Remove the environment named 'DEV'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ExternalFeed --> <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-ExternalFeed</command:name> <command:verb>Get</command:verb> <command:noun>ExternalFeed</command:noun> <maml:description> <maml:para>Gets the external feeds in the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoExternalFeed cmdlet gets the external feeds in the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ExternalFeed</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to get deployments 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to get deployments 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the project to get deployments for.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octoexternalfeed</dev:code> <dev:remarks> <maml:para>This command gets all the external feeds.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-Feed --> <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>Add-Feed</command:name> <command:verb>Add</command:verb> <command:noun>Feed</command:noun> <maml:description> <maml:para>Add a new external feed to the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoFeed cmdlet adds a external feed to the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-Feed</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the feed to create.</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: Uri --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The URI of the feed to create.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the feed to create.</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: Uri --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Uri</maml:name> <maml:description> <maml:para>The URI of the feed to create.</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>The name of the feed to create.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octofeed DEV</dev:code> <dev:remarks> <maml:para>Add a new feed named 'DEV'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>add-octofeed -Name DEV -Uri "\\test"</dev:code> <dev:remarks> <maml:para>Add a new feed named 'DEV' pointing to the path '\\test'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-LibraryVariable --> <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>Add-LibraryVariable</command:name> <command:verb>Add</command:verb> <command:noun>LibraryVariable</command:noun> <maml:description> <maml:para>Add a varaiable to an Octopus Deploy library variable set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-OctoVariableSetVariable cmdlet adds a varaiable to an Octopus Deploy library variable set.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByParts --> <command:syntaxItem> <maml:name>Add-LibraryVariable</maml:name> <!-- Parameter: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The name of the library variable set to add the variable 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to create.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the variable to create.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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: ByObject --> <command:syntaxItem> <maml:name>Add-LibraryVariable</maml:name> <!-- Parameter: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The name of the library variable set to add the variable 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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">VariableResource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The name of the library variable set to add the variable 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to create.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the variable to create.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">VariableResource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</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>The name of the library variable set to add the variable 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>The environments to restrict the scope to.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octolibraryvariable -VariableSet Database -Name ConnectionString</dev:code> <dev:remarks> <maml:para>Add a variable named 'ConnectionString' to the library variable named 'Database'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>add-octolibraryvariable Database ConnectionString -Environments DEV</dev:code> <dev:remarks> <maml:para>Add a variable named 'ConnectionString' to the library variable named 'Database'. Set the variable scope to the 'DEV' environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>get-octovariable -Project Example -Name ConnectionString | % { add-octolibraryvariable Database $_ }</dev:code> <dev:remarks> <maml:para>Find all the variables in the project 'Example' with the name 'ConnectionString' and add them to the library variable set named 'Database'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-LibraryVariable --> <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-LibraryVariable</command:name> <command:verb>Update</command:verb> <command:noun>LibraryVariable</command:noun> <maml:description> <maml:para>Update an existing variable in an Octopus Deploy Library Variable Set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Update-OctoLibraryVariable cmdlet updates an existing variable in and Octopus Deploy Library Variable Set.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Parts --> <command:syntaxItem> <maml:name>Update-LibraryVariable</maml:name> <!-- Parameter: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The name of the library variable set containing the variable to update.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the variable to update.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name of the variable.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the variable.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The name of the library variable set containing the variable to update.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the variable to update.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name of the variable.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the variable.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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>The name of the library variable set containing the variable to update.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The environments to restrict the scope to.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>update-octolibraryvariable VariableSet variables-1 NewName</dev:code> <dev:remarks> <maml:para>Give the variable in the library variable set 'VariableSet', with the id 'variables-1', the name 'NewName'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>update-octovariable -Project Project -Id variables-1 -Name NewName -Value "New Value" -Environments "DEV", "TEST"</dev:code> <dev:remarks> <maml:para>Give the variable in the project 'Project', with the id 'variables-1', the name 'NewName', value "New Value" and restrict the scope to the DEV and TEST environments.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-Machine --> <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>Add-Machine</command:name> <command:verb>Add</command:verb> <command:noun>Machine</command:noun> <maml:description> <maml:para>Add a new machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoMachine cmdlet adds a new machine (tentacle) to Octopus.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Add-Machine</maml:name> <!-- Parameter: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the environment to add the machine 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine.</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: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles that the machine will perform.</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: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>The communication style of the server. Either TentacleActive or TentaclePassive.</maml:para> </maml:description> <command:parameterValue required="true">EndpointResource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Endpoints.EndpointResource</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsDisabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsDisabled</maml:name> <maml:description> <maml:para>The communication style of the server. Either TentacleActive or TentaclePassive.</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: ById --> <command:syntaxItem> <maml:name>Add-Machine</maml:name> <!-- Parameter: EnvironmentId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentId</maml:name> <maml:description> <maml:para>The id of the environment to add the machine 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine.</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: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles that the machine will perform.</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: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>The communication style of the server. Either TentacleActive or TentaclePassive.</maml:para> </maml:description> <command:parameterValue required="true">EndpointResource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Endpoints.EndpointResource</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsDisabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsDisabled</maml:name> <maml:description> <maml:para>The communication style of the server. Either TentacleActive or TentaclePassive.</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: Environment --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Environment</maml:name> <maml:description> <maml:para>The name of the environment to add the machine 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: EnvironmentId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>EnvironmentId</maml:name> <maml:description> <maml:para>The id of the environment to add the machine 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine.</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: Roles --> <command:parameter required="true" globbing="false" pipelineInput="false" position="3"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles that the machine will perform.</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: Endpoint --> <command:parameter required="true" globbing="false" pipelineInput="false" position="5"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>The communication style of the server. Either TentacleActive or TentaclePassive.</maml:para> </maml:description> <command:parameterValue required="true">EndpointResource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.Endpoints.EndpointResource</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: IsDisabled --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>IsDisabled</maml:name> <maml:description> <maml:para>The communication style of the server. Either TentacleActive or TentaclePassive.</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>The name of the machine.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-Machine --> <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-Machine</command:name> <command:verb>Get</command:verb> <command:noun>Machine</command:noun> <maml:description> <maml:para>Get a machine from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoMachine cmdlet gets a machine from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Machine</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine to retrieve.</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: ById --> <command:syntaxItem> <maml:name>Get-Machine</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the machine to retrieve.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine to retrieve.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the machine to retrieve.</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>The name of the machine to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octomachine</dev:code> <dev:remarks> <maml:para>Get all the machines.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>get-octomachine web-01</dev:code> <dev:remarks> <maml:para>Get the machine named 'web-01'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-MachineRole --> <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-MachineRole</command:name> <command:verb>Get</command:verb> <command:noun>MachineRole</command:noun> <maml:description> <maml:para>Get a machine role from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoMachineRole cmdlet gets a machine role from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-MachineRole</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine role to retrieve.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the machine role to retrieve.</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>The name of the machine role to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octomachinerole</dev:code> <dev:remarks> <maml:para>Get all the machine roles.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>get-octomachinerole webserver, databaseserver</dev:code> <dev:remarks> <maml:para>Get machine roles WebServer and DatabaseServer. Could be used to verify the roles currently exist.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-Project --> <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>Add-Project</command:name> <command:verb>Add</command:verb> <command:noun>Project</command:noun> <maml:description> <maml:para>Add a new deployment project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoProject cmdlet adds a new deployment project to Octopus.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Add-Project</maml:name> <!-- Parameter: ProjectGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectGroupName</maml:name> <maml:description> <maml:para>The name of the ProjectGroup to create the project in.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to create.</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="true (ByPropertyName)" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the project to create.</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: ById --> <command:syntaxItem> <maml:name>Add-Project</maml:name> <!-- Parameter: ProjectGroupId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectGroupId</maml:name> <maml:description> <maml:para>The id of the ProjectGroup to create the project in.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to create.</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="true (ByPropertyName)" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the project to create.</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: ProjectGroupName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectGroupName</maml:name> <maml:description> <maml:para>The name of the ProjectGroup to create the project in.</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: ProjectGroupId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectGroupId</maml:name> <maml:description> <maml:para>The id of the ProjectGroup to create the project in.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to create.</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="true (ByPropertyName)" position="2"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the project to create.</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>The name of the project to create.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octoproject ExampleGroup ExampleProject</dev:code> <dev:remarks> <maml:para>Add a new project named 'ExampleProject' to the group 'ExampleGroup'</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-Project --> <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>Copy-Project</command:name> <command:verb>Copy</command:verb> <command:noun>Project</command:noun> <maml:description> <maml:para>Copy a project in the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoProject cmdlet copies a project in the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-Project</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to copy.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination name of the new project.</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: ProjectGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ProjectGroup</maml:name> <maml:description> <maml:para>The name of the ProjectGroup to create the project in.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to copy.</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: Destination --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The destination name of the new project.</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: ProjectGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>ProjectGroup</maml:name> <maml:description> <maml:para>The name of the ProjectGroup to create the project in.</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>The name of the project to copy.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>copy-octoproject -Name Example -Destination "Example - Copy" -ProjectGroup ExampleGroup</dev:code> <dev:remarks> <maml:para>Make a copy of the project 'Example', name it 'Example - Copy' and place it in the project group named 'ExampleGroup'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Project --> <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-Project</command:name> <command:verb>Get</command:verb> <command:noun>Project</command:noun> <maml:description> <maml:para>Gets the projects in the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoProject cmdlet gets the projects in the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-Project</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to retrieve.</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: ProjectGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectGroup</maml:name> <maml:description> <maml:para>The name of the project groups to look in.</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: Exclude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>The name of the projects to exclude from the results.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Tells the command to load and cache all the projects.</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: ById --> <command:syntaxItem> <maml:name>Get-Project</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Tells the command to load and cache all the projects.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to retrieve.</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: ProjectGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ProjectGroup</maml:name> <maml:description> <maml:para>The name of the project groups to look in.</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: Exclude --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>The name of the projects to exclude from the results.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Tells the command to load and cache all the projects.</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>The name of the project to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octoproject</dev:code> <dev:remarks> <maml:para>Get all the projects.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-Project --> <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-Project</command:name> <command:verb>Remove</command:verb> <command:noun>Project</command:noun> <maml:description> <maml:para>Remove a project from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OctoProject cmdlet removes a project from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-Project</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to remove.</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: ById --> <command:syntaxItem> <maml:name>Remove-Project</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to remove.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to remove.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to remove.</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>The name of the project to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>remove-octoproject Project</dev:code> <dev:remarks> <maml:para>Remove the project named 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-ProjectGroup --> <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>Add-ProjectGroup</command:name> <command:verb>Add</command:verb> <command:noun>ProjectGroup</command:noun> <maml:description> <maml:para>Add a new project group to the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoProjectGroup cmdlet adds a new project group to the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-ProjectGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project group to create.</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="true (ByPropertyName)" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the project group to create.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project group to create.</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="true (ByPropertyName)" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the project group to create.</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>The name of the project group to create.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octoprojectgroup ExampleGroup</dev:code> <dev:remarks> <maml:para>Add a new project group named 'ExampleGroup'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ProjectGroup --> <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-ProjectGroup</command:name> <command:verb>Get</command:verb> <command:noun>ProjectGroup</command:noun> <maml:description> <maml:para>Get a project group from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoProjectGroup cmdlet gets a project group from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-ProjectGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project group to retrieve.</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: ById --> <command:syntaxItem> <maml:name>Get-ProjectGroup</maml:name> <!-- Parameter: ProjectGroupId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ProjectGroupId</maml:name> <maml:description> <maml:para>The id of the project group to retrieve.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project group to retrieve.</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: ProjectGroupId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ProjectGroupId</maml:name> <maml:description> <maml:para>The id of the project group to retrieve.</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>The name of the project group to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octoprojectgroup</dev:code> <dev:remarks> <maml:para>Get all the project groups.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-ProjectGroup --> <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-ProjectGroup</command:name> <command:verb>Remove</command:verb> <command:noun>ProjectGroup</command:noun> <maml:description> <maml:para>Remove a project group from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OctoProjectGroup cmdlet removes a project group from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-ProjectGroup</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project group to remove.</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: ById --> <command:syntaxItem> <maml:name>Remove-ProjectGroup</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project group to remove.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project group to remove.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project group to remove.</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>The name of the project group to remove.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>remove-octoprojectgroup Group</dev:code> <dev:remarks> <maml:para>Remove the project group named 'Group'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Release --> <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-Release</command:name> <command:verb>Get</command:verb> <command:noun>Release</command:noun> <maml:description> <maml:para>Get a release from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoRelease cmdlet gets a release from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByProject --> <command:syntaxItem> <maml:name>Get-Release</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to get the release 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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version number of the release to retrieve.</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: ByProjectId --> <command:syntaxItem> <maml:name>Get-Release</maml:name> <!-- Parameter: ProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The id of the project to get the release 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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version number of the release to retrieve.</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: ById --> <command:syntaxItem> <maml:name>Get-Release</maml:name> <!-- Parameter: ReleaseId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The id of the release to retrieve.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to get the release 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: ProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The id of the project to get the release 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: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version number of the release to retrieve.</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: ReleaseId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>The id of the release to retrieve.</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>The id of the release to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octorelease Project</dev:code> <dev:remarks> <maml:para>Get all the releases for the project 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Connect-Server --> <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>Connect-Server</command:name> <command:verb>Connect</command:verb> <command:noun>Server</command:noun> <maml:description> <maml:para>Connects your session to the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-OctoServer cmdlet connects your session to the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Connect-Server</maml:name> <!-- Parameter: Server --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>The address of the Octopus Deploy 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="false" position="1"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The generated ApiKey for the profile you wish to connect as.</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="false" position="0"> <maml:name>Server</maml:name> <maml:description> <maml:para>The address of the Octopus Deploy 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="false" position="1"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The generated ApiKey for the profile you wish to connect as.</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 /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>connect-octoserver http://localhost:8080/ API-ABCDEFGHIJKLMNOPQRSTUVWXYZ</dev:code> <dev:remarks> <maml:para>This command connects to the Octopus Deploy server at http://localhost:8080/ with the APIKEY API-ABCDEFGHIJKLMNOPQRSTUVWXYZ.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Copy-Step --> <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>Copy-Step</command:name> <command:verb>Copy</command:verb> <command:noun>Step</command:noun> <maml:description> <maml:para>Copy a deployment process step in an Octopus Deploy project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoCopyStep cmdlet copies a deployment process step in an Octopus Deploy project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Copy-Step</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project containing the step to copy.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the step to copy.</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: Destination --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The new name of the step.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project containing the step to copy.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the step to copy.</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: Destination --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Destination</maml:name> <maml:description> <maml:para>The new name of the step.</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>The name of the step to copy.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>copy-octostep Example Website</dev:code> <dev:remarks> <maml:para>Make a copy the step named 'Website' in the project named 'Example'. Since no destination argument was specified, the new step will be named 'Website - Copy'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Step --> <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-Step</command:name> <command:verb>Get</command:verb> <command:noun>Step</command:noun> <maml:description> <maml:para>Get a deployment step for an Octopus Deploy project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoStep cmdlet gets a deployment step for an Octopus Deploy project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByProjectName --> <command:syntaxItem> <maml:name>Get-Step</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to retrieve the step 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the step to retrieve.</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: ByProjectId --> <command:syntaxItem> <maml:name>Get-Step</maml:name> <!-- Parameter: ProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The id of the project to retrieve the step 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the step to retrieve.</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: ByDeploymentProcessId --> <command:syntaxItem> <maml:name>Get-Step</maml:name> <!-- Parameter: DeploymentProcessId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DeploymentProcessId</maml:name> <maml:description> <maml:para>The id of the deployment process to retrieve.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the step to retrieve.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to retrieve the step 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: ProjectId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>The id of the project to retrieve the step 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: DeploymentProcessId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>DeploymentProcessId</maml:name> <maml:description> <maml:para>The id of the deployment process to retrieve.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the step to retrieve.</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>The name of the step to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octostep Project</dev:code> <dev:remarks> <maml:para>Get all deployment steps for the project 'Project'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>get-octostep -ProjectId projects-1</dev:code> <dev:remarks> <maml:para>Get all deployment steps for the project with the id 'projects-1'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>PS C:\>get-octostep -DeploymentProcessId deploymentprocess-1</dev:code> <dev:remarks> <maml:para>Get all deployment steps for the deploymentprocess with the id 'projects-1'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-Variable --> <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>Add-Variable</command:name> <command:verb>Add</command:verb> <command:noun>Variable</command:noun> <maml:description> <maml:para>Add a new variable to an Octopus Deploy project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoVariable cmdlet adds a new variable to an Octopus Deploy project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByParts --> <command:syntaxItem> <maml:name>Add-Variable</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to add the variable 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to create.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the variable to create.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Steps --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Steps</maml:name> <maml:description> <maml:para>The deployment steps to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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: ByObject --> <command:syntaxItem> <maml:name>Add-Variable</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to add the variable 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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">VariableResource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to add the variable 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to create.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the variable to create.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Steps --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Steps</maml:name> <maml:description> <maml:para>The deployment steps to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">VariableResource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</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>The name of the project to add the variable 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>The environments to restrict the scope to.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octovariable -Project Example -Name ConnectionString</dev:code> <dev:remarks> <maml:para>Add a variable named 'ConnectionString' to the project name 'Example'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-Variable --> <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-Variable</command:name> <command:verb>Get</command:verb> <command:noun>Variable</command:noun> <maml:description> <maml:para>Get a variable from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoVariable cmdlet gets a variable from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Project --> <command:syntaxItem> <maml:name>Get-Variable</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the variables 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to retrieve.</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: VariableSet --> <command:syntaxItem> <maml:name>Get-Variable</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to retrieve.</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: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The library variable set to get the variables 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> <!-- Parameter set: VariableSetId --> <command:syntaxItem> <maml:name>Get-Variable</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to retrieve.</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: VariableSetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>VariableSetId</maml:name> <maml:description> <maml:para>"The id of the library variable set to get the variables 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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get the variables 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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to retrieve.</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: VariableSet --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>VariableSet</maml:name> <maml:description> <maml:para>The library variable set to get the variables 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: VariableSetId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>VariableSetId</maml:name> <maml:description> <maml:para>"The id of the library variable set to get the variables 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The name of the variable to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octovariable Project</dev:code> <dev:remarks> <maml:para>Get all the variables for the project 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-Variable --> <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-Variable</command:name> <command:verb>Remove</command:verb> <command:noun>Variable</command:noun> <maml:description> <maml:para>Remove a variable from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OctoVariable cmdlet removes a variable from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-Variable</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to remove the variable from.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to remove.</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: ByObject --> <command:syntaxItem> <maml:name>Remove-Variable</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to remove the variable from.</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">VariableResource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to remove the variable from.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to remove.</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">VariableResource[]</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</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>The name of the variable to remove.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.VariableResource[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>remove-octovariable Project Variable</dev:code> <dev:remarks> <maml:para>Remove the variable 'Variable' from the project 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Update-Variable --> <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-Variable</command:name> <command:verb>Update</command:verb> <command:noun>Variable</command:noun> <maml:description> <maml:para>Update an existing variable in the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Update-OctoVariable cmdlet updates an existing variable in the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Parts --> <command:syntaxItem> <maml:name>Update-Variable</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project containing the variable to update.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the variable to update.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name of the variable.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the variable.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project containing the variable to update.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the variable to update.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name of the variable.</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: Value --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the variable.</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: Environments --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Environments</maml:name> <maml:description> <maml:para>The environments to restrict the scope 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: Roles --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Roles</maml:name> <maml:description> <maml:para>The roles to restrict the scope 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: Machines --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Machines</maml:name> <maml:description> <maml:para>The machines to restrict the scope 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: Sensitive --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Sensitive</maml:name> <maml:description> <maml:para>Specifies whether the variable is sensitive (value should be hidden).</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:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>update-octovariable Project variables-1 NewName</dev:code> <dev:remarks> <maml:para>Give the variable in the project 'Project', with the id 'variables-1', the name 'NewName'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>PS C:\>update-octovariable -Project Project -Id variables-1 -Name NewName -Value "New Value" -Environments "DEV", "TEST"</dev:code> <dev:remarks> <maml:para>Give the variable in the project 'Project', with the id 'variables-1', the name 'NewName', value "New Value" and restrict the scope to the DEV and TEST environments.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-VariableSet --> <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>Add-VariableSet</command:name> <command:verb>Add</command:verb> <command:noun>VariableSet</command:noun> <maml:description> <maml:para>Add a new library variable set to the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-OctoVariableSet cmdlet adds a new library variable set to the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-VariableSet</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the VariableSet to create.</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="true (ByPropertyName)" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the VariableSet to create.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the VariableSet to create.</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="true (ByPropertyName)" position="1"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the VariableSet to create.</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>The name of the VariableSet to create.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>add-octovariableset -Name ConnectionStrings -Description 'Various Database connection strings'</dev:code> <dev:remarks> <maml:para>Add a variableset named 'ConnectionStrings' with the description 'Various Database connection strings'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-VariableSet --> <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-VariableSet</command:name> <command:verb>Get</command:verb> <command:noun>VariableSet</command:noun> <maml:description> <maml:para>Get a library variable set from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-OctoVariableSet cmdlet gets a library variable set from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Get-VariableSet</maml:name> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable set to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Tells the command to load and cache all the variable sets.</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: ById --> <command:syntaxItem> <maml:name>Get-VariableSet</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the variable set to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Tells the command to load and cache all the variable sets.</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: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable set to retrieve.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the variable set to retrieve.</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: Cache --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Cache</maml:name> <maml:description> <maml:para>Tells the command to load and cache all the variable sets.</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>The name of the variable set to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>get-octovariableset</dev:code> <dev:remarks> <maml:para>Get all the variable sets.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Remove-VariableSet --> <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-VariableSet</command:name> <command:verb>Remove</command:verb> <command:noun>VariableSet</command:noun> <maml:description> <maml:para>Remove a variable set from the Octopus Deploy server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-OctoVariableSet cmdlet removes a variable set from the Octopus Deploy server.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: ByName --> <command:syntaxItem> <maml:name>Remove-VariableSet</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the library variable set to remove.</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: ById --> <command:syntaxItem> <maml:name>Remove-VariableSet</maml:name> <!-- Parameter: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the variable set to remove.</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: ByObject --> <command:syntaxItem> <maml:name>Remove-VariableSet</maml:name> <!-- Parameter: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more library variableset objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">LibraryVariableSetResource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.LibraryVariableSetResource</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the library variable set to remove.</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: Id --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>The Id of the variable set to remove.</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: InputObject --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies one or more library variableset objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> <command:parameterValue required="true">LibraryVariableSetResource</command:parameterValue> <dev:type> <maml:name>Octopus.Client.Model.LibraryVariableSetResource</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>The name of the library variable set to remove.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Octopus.Client.Model.LibraryVariableSetResource</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies one or more library variableset objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>remove-octovariableset VariableSet</dev:code> <dev:remarks> <maml:para>Remove the variableset 'VariableSet'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Use-VariableSet --> <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>Use-VariableSet</command:name> <command:verb>Use</command:verb> <command:noun>VariableSet</command:noun> <maml:description> <maml:para>Include a variable set in your project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Use-OctoVariableSet cmdlet includes a variable set in your project.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Use-VariableSet</maml:name> <!-- Parameter: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to include the variable set 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The variable set names to include.</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: Project --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to include the variable set 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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>The variable set names to include.</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>The project to include the variable set into.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The variable set names to include.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>PS C:\>use-octovariableset Project VariableSet</dev:code> <dev:remarks> <maml:para>Include the library variable set 'VariableSet' in the project 'Project'.</maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Find-VariableSetVariable --> <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>Find-VariableSetVariable</command:name> <command:verb>Find</command:verb> <command:noun>VariableSetVariable</command:noun> <maml:description> <maml:para>Find a varaiable in an Octopus Deploy library variable set.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Find-OctoVariableSetVariable cmdlet finds a varaiable in an Octopus Deploy library variable set</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-VariableSetVariable</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to retrieve.</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: VariableSetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VariableSetName</maml:name> <maml:description> <maml:para>The name of the VariableSet to look in.</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: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the variable to retrieve.</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: VariableSetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>VariableSetName</maml:name> <maml:description> <maml:para>The name of the VariableSet to look in.</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>The name of the variable to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> </helpItems> |