Octopus-Cmdlets.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Octopus-Cmdlets</name> </assembly> <members> <member name="T:Octopus_Cmdlets.AddEnvironment"> <summary> <para type="synopsis">Add a new environment to the Octopus Deploy server.</para> <para type="description">The Add-OctoEnvironment cmdlet adds a new environment to the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>add-octoenvironment DEV</code> <para> Add a new environment named 'DEV'. </para> </example> <example> <code>PS C:\>add-octoenvironment -Name DEV -Description "Our development environment"</code> <para> Add a new environment named 'DEV' with a description. </para> </example> </member> <member name="P:Octopus_Cmdlets.AddEnvironment.Name"> <summary> <para type="description">The name of the environment to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddEnvironment.Description"> <summary> <para type="description">The description of the environment to create.</para> </summary> </member> <member name="M:Octopus_Cmdlets.AddEnvironment.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddEnvironment.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.AddFeed"> <summary> <para type="synopsis">Add a new external feed to the Octopus Deploy server.</para> <para type="description">The Add-OctoFeed cmdlet adds a external feed to the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>add-octofeed DEV</code> <para> Add a new feed named 'DEV'. </para> </example> <example> <code>PS C:\>add-octofeed -Name DEV -Uri "\\test"</code> <para> Add a new feed named 'DEV' pointing to the path '\\test'. </para> </example> </member> <member name="P:Octopus_Cmdlets.AddFeed.Name"> <summary> <para type="description">The name of the feed to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddFeed.Uri"> <summary> <para type="description">The URI of the feed to create.</para> </summary> </member> <member name="M:Octopus_Cmdlets.AddFeed.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddFeed.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.AddLibraryVariable"> <summary> <para type="synopsis">Add a varaiable to an Octopus Deploy library variable set.</para> <para type="description">The Find-OctoVariableSetVariable cmdlet adds a varaiable to an Octopus Deploy library variable set.</para> </summary> <example> <code>PS C:\>add-octolibraryvariable -VariableSet Database -Name ConnectionString</code> <para> Add a variable named 'ConnectionString' to the library variable named 'Database'. </para> </example> <example> <code>PS C:\>add-octolibraryvariable Database ConnectionString -Environments DEV</code> <para> Add a variable named 'ConnectionString' to the library variable named 'Database'. Set the variable scope to the 'DEV' environment. </para> </example> <example> <code>PS C:\>get-octovariable -Project Example -Name ConnectionString | % { add-octolibraryvariable Database $_ }</code> <para> Find all the variables in the project 'Example' with the name 'ConnectionString' and add them to the library variable set named 'Database'. </para> </example> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.VariableSet"> <summary> <para type="description">The name of the library variable set to add the variable to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.Name"> <summary> <para type="description">The name of the variable to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.Value"> <summary> <para type="description">The value of the variable to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.Environments"> <summary> <para type="description">The environments to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.Roles"> <summary> <para type="description">The roles to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.Machines"> <summary> <para type="description">The machines to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.Sensitive"> <summary> <para type="description">Specifies whether the variable is sensitive (value should be hidden).</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddLibraryVariable.InputObject"> <summary> <para type="description"> Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects. </para> </summary> </member> <member name="M:Octopus_Cmdlets.AddLibraryVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddLibraryVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.AddLibraryVariable.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.AddMachine"> <summary> <para type="synopsis">Add a new machine.</para> <para type="description">The Add-OctoMachine cmdlet adds a new machine (tentacle) to Octopus.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddMachine.Environment"> <summary> <para type="description">The name of the environment to add the machine to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddMachine.EnvironmentId"> <summary> <para type="description">The id of the environment to add the machine to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddMachine.Name"> <summary> <para type="description">The name of the machine.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddMachine.Roles"> <summary> <para type="description">The roles that the machine will perform.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddMachine.Endpoint"> <summary> <para type="description"> The communication style of the server. Either TentacleActive or TentaclePassive. </para> </summary> </member> <member name="P:Octopus_Cmdlets.AddMachine.IsDisabled"> <summary> <para type="description"> The communication style of the server. Either TentacleActive or TentaclePassive. </para> </summary> </member> <member name="M:Octopus_Cmdlets.AddMachine.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddMachine.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.AddProject"> <summary> <para type="synopsis">Add a new deployment project.</para> <para type="description">The Add-OctoProject cmdlet adds a new deployment project to Octopus.</para> </summary> <example> <code>PS C:\>add-octoproject ExampleGroup ExampleProject</code> <para> Add a new project named 'ExampleProject' to the group 'ExampleGroup' </para> </example> </member> <member name="P:Octopus_Cmdlets.AddProject.ProjectGroupName"> <summary> <para type="description">The name of the ProjectGroup to create the project in.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddProject.ProjectGroupId"> <summary> <para type="description">The id of the ProjectGroup to create the project in.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddProject.Name"> <summary> <para type="description">The name of the project to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddProject.Description"> <summary> <para type="description">The description of the project to create.</para> </summary> </member> <member name="M:Octopus_Cmdlets.AddProject.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddProject.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.AddProjectGroup"> <summary> <para type="synopsis">Add a new project group to the Octopus Deploy server.</para> <para type="description">The Add-OctoProjectGroup cmdlet adds a new project group to the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>add-octoprojectgroup ExampleGroup</code> <para> Add a new project group named 'ExampleGroup'. </para> </example> </member> <member name="P:Octopus_Cmdlets.AddProjectGroup.Name"> <summary> <para type="description">The name of the project group to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddProjectGroup.Description"> <summary> <para type="description">The description of the project group to create.</para> </summary> </member> <member name="M:Octopus_Cmdlets.AddProjectGroup.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddProjectGroup.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.AddVariable"> <summary> <para type="synopsis">Add a new variable to an Octopus Deploy project.</para> <para type="description">The Add-OctoVariable cmdlet adds a new variable to an Octopus Deploy project.</para> </summary> <example> <code>PS C:\>add-octovariable -Project Example -Name ConnectionString</code> <para> Add a variable named 'ConnectionString' to the project name 'Example'. </para> </example> </member> <member name="P:Octopus_Cmdlets.AddVariable.Project"> <summary> <para type="description">The name of the project to add the variable to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Name"> <summary> <para type="description">The name of the variable to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Value"> <summary> <para type="description">The value of the variable to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Environments"> <summary> <para type="description">The environments to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Roles"> <summary> <para type="description">The roles to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Machines"> <summary> <para type="description">The machines to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Steps"> <summary> <para type="description">The deployment steps to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.Sensitive"> <summary> <para type="description">Specifies whether the variable is sensitive (value should be hidden).</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariable.InputObject"> <summary> <para type="description"> Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects. </para> </summary> </member> <member name="M:Octopus_Cmdlets.AddVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.AddVariable.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.AddVariableSet"> <summary> <para type="synopsis">Add a new library variable set to the Octopus Deploy server.</para> <para type="description">The Add-OctoVariableSet cmdlet adds a new library variable set to the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>add-octovariableset -Name ConnectionStrings -Description 'Various Database connection strings'</code> <para> Add a variableset named 'ConnectionStrings' with the description 'Various Database connection strings'. </para> </example> </member> <member name="P:Octopus_Cmdlets.AddVariableSet.Name"> <summary> <para type="description">The name of the VariableSet to create.</para> </summary> </member> <member name="P:Octopus_Cmdlets.AddVariableSet.Description"> <summary> <para type="description">The description of the VariableSet to create.</para> </summary> </member> <member name="M:Octopus_Cmdlets.AddVariableSet.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.AddVariableSet.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.ConnectServer"> <summary> <para type="synopsis">Connects your session to the Octopus Deploy server.</para> <para type="description">The Connect-OctoServer cmdlet connects your session to the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>connect-octoserver http://localhost:8080/ API-ABCDEFGHIJKLMNOPQRSTUVWXYZ</code> <para> This command connects to the Octopus Deploy server at http://localhost:8080/ with the APIKEY API-ABCDEFGHIJKLMNOPQRSTUVWXYZ. </para> </example> </member> <member name="P:Octopus_Cmdlets.ConnectServer.Server"> <summary> <para type="description">The address of the Octopus Deploy server you want to connect to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.ConnectServer.ApiKey"> <summary> <para type="description">The generated ApiKey for the profile you wish to connect as.</para> </summary> </member> <member name="M:Octopus_Cmdlets.ConnectServer.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.CopyChannel"> <summary> <para type="synopsis">Copy a channel in an Octopus Deploy project.</para> <para type="description">The Get-OctoCopyChannel cmdlet copies a channel in an Octopus Deploy project.</para> </summary> <example> <code>PS C:\>copy-octochannel Example Website</code> <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'. </para> </example> </member> <member name="P:Octopus_Cmdlets.CopyChannel.Project"> <summary> <para type="description">The name of the project containing the channel to copy.</para> </summary> </member> <member name="P:Octopus_Cmdlets.CopyChannel.Name"> <summary> <para type="description">The name of the channel to copy.</para> </summary> </member> <member name="P:Octopus_Cmdlets.CopyChannel.Destination"> <summary> <para type="description">The name of the new channel.</para> </summary> </member> <member name="M:Octopus_Cmdlets.CopyChannel.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.CopyChannel.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.CopyProject"> <summary> <para type="synopsis">Copy a project in the Octopus Deploy server.</para> <para type="description">The Get-OctoProject cmdlet copies a project in the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>copy-octoproject -Name Example -Destination "Example - Copy" -ProjectGroup ExampleGroup</code> <para> Make a copy of the project 'Example', name it 'Example - Copy' and place it in the project group named 'ExampleGroup'. </para> </example> </member> <member name="P:Octopus_Cmdlets.CopyProject.Name"> <summary> <para type="description">The name of the project to copy.</para> </summary> </member> <member name="P:Octopus_Cmdlets.CopyProject.Destination"> <summary> <para type="description">The destination name of the new project.</para> </summary> </member> <member name="P:Octopus_Cmdlets.CopyProject.ProjectGroup"> <summary> <para type="description">The name of the ProjectGroup to create the project in.</para> </summary> </member> <member name="M:Octopus_Cmdlets.CopyProject.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.CopyProject.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.CopyProject.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.CopyStep"> <summary> <para type="synopsis">Copy a deployment process step in an Octopus Deploy project.</para> <para type="description">The Get-OctoCopyStep cmdlet copies a deployment process step in an Octopus Deploy project.</para> </summary> <example> <code>PS C:\>copy-octostep Example Website</code> <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'. </para> </example> </member> <member name="P:Octopus_Cmdlets.CopyStep.Project"> <summary> <para type="description">The name of the project containing the step to copy.</para> </summary> </member> <member name="P:Octopus_Cmdlets.CopyStep.Name"> <summary> <para type="description">The name of the step to copy.</para> </summary> </member> <member name="P:Octopus_Cmdlets.CopyStep.Destination"> <summary> <para type="description">The new name of the step.</para> </summary> </member> <member name="M:Octopus_Cmdlets.CopyStep.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.CopyStep.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.CopyStep.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.FindVariableSetVariable"> <summary> <para type="synopsis">Find a varaiable in an Octopus Deploy library variable set.</para> <para type="description">The Find-OctoVariableSetVariable cmdlet finds a varaiable in an Octopus Deploy library variable set</para> </summary> </member> <member name="P:Octopus_Cmdlets.FindVariableSetVariable.Name"> <summary> <para type="description">The name of the variable to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.FindVariableSetVariable.VariableSetName"> <summary> <para type="description">The name of the VariableSet to look in.</para> </summary> </member> <member name="M:Octopus_Cmdlets.FindVariableSetVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.FindVariableSetVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetAction"> <summary> <para type="synopsis">Get an action role from the Octopus Deploy server.</para> <para type="description">The Get-OctoAction cmdlet gets an action from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octoaction Project</code> <para> Get all the actions in the project named 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetAction.Project"> <summary> <para type="description">The project to get the action for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetAction.Name"> <summary> <para type="description">The name of the action to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetAction.Id"> <summary> <para type="description">The id of the action to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetAction.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetAction.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetDeployment"> <summary> <para type="synopsis">Get a deployment from the Octopus Deploy server.</para> <para type="description">The Get-OctoDeployment cmdlet gets a deployment from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octodeployment Project v1.0.1</code> <para> Get all the deployments of the release 'v1.01.' for the project named 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetDeployment.Project"> <summary> <para type="description">The name of the project to get deployments for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetDeployment.Release"> <summary> <para type="description">The name of the release to get deployments for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetDeployment.ReleaseId"> <summary> <para type="description">The id of the release to get deployments for.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetDeployment.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetDeployment.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetDeploymentProcess"> <summary> <para type="synopsis">Get a deployment process from the Octopus Deploy server.</para> <para type="description">The Get-OctoDeploymentProcess cmdlet gets a deployment process from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octodeploymentprocess Project</code> <para> Get the deployment process for the project 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetDeploymentProcess.Project"> <summary> <para type="description">The name of the project to retrieve the process for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetDeploymentProcess.DeploymentProcessId"> <summary> <para type="description">The id of the deployment process to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetDeploymentProcess.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetDeploymentProcess.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetEnvironment"> <summary> <para type="synopsis">Gets the environments in the Octopus Deploy server.</para> <para type="description">The Get-OctoEnvironment cmdlet gets the environments in the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octoenvironment</code> <para>This command gets all the environments.</para> </example> </member> <member name="P:Octopus_Cmdlets.GetEnvironment.Name"> <summary> <para type="description">The name of the environment to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetEnvironment.EnvironmentId"> <summary> <para type="description">The id of the environment to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetEnvironment.ScopeValue"> <summary> <para type="description">The environment to retrieve by ScopeValue.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetEnvironment.Cache"> <summary> <para type="description">Determines whether to temporarily cache the results or not.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetEnvironment.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetEnvironment.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetExternalFeed"> <summary> <para type="synopsis">Gets the external feeds in the Octopus Deploy server.</para> <para type="description">The Get-OctoExternalFeed cmdlet gets the external feeds in the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octoexternalfeed</code> <para>This command gets all the external feeds.</para> </example> </member> <member name="P:Octopus_Cmdlets.GetExternalFeed.Name"> <summary> <para type="description">The name of the project to get deployments for.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetExternalFeed.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetExternalFeed.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetMachine"> <summary> <para type="synopsis">Get a machine from the Octopus Deploy server.</para> <para type="description">The Get-OctoMachine cmdlet gets a machine from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octomachine</code> <para> Get all the machines. </para> </example> <example> <code>PS C:\>get-octomachine web-01</code> <para> Get the machine named 'web-01' </para> </example> </member> <member name="P:Octopus_Cmdlets.GetMachine.Name"> <summary> <para type="description">The name of the machine to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetMachine.Id"> <summary> <para type="description">The id of the machine to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetMachine.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetMachine.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetMachineRole"> <summary> <para type="synopsis">Get a machine role from the Octopus Deploy server.</para> <para type="description">The Get-OctoMachineRole cmdlet gets a machine role from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octomachinerole</code> <para> Get all the machine roles. </para> </example> <example> <code>PS C:\>get-octomachinerole webserver, databaseserver</code> <para> Get machine roles WebServer and DatabaseServer. Could be used to verify the roles currently exist. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetMachineRole.Name"> <summary> <para type="description">The name of the machine role to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetMachineRole.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetMachineRole.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetProject"> <summary> <para type="synopsis">Gets the projects in the Octopus Deploy server.</para> <para type="description">The Get-OctoProject cmdlet gets the projects in the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octoproject</code> <para> Get all the projects. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetProject.Name"> <summary> <para type="description">The name of the project to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetProject.ProjectGroup"> <summary> <para type="description">The name of the project groups to look in.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetProject.Exclude"> <summary> <para type="description">The name of the projects to exclude from the results.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetProject.Id"> <summary> <para type="description">The id of the project to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetProject.Cache"> <summary> <para type="description">Tells the command to load and cache all the projects.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetProject.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetProject.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetProjectGroup"> <summary> <para type="synopsis">Get a project group from the Octopus Deploy server.</para> <para type="description">The Get-OctoProjectGroup cmdlet gets a project group from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octoprojectgroup</code> <para> Get all the project groups. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetProjectGroup.Name"> <summary> <para type="description">The name of the project group to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetProjectGroup.ProjectGroupId"> <summary> <para type="description">The id of the project group to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetProjectGroup.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetProjectGroup.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetRelease"> <summary> <para type="synopsis">Get a release from the Octopus Deploy server.</para> <para type="description">The Get-OctoRelease cmdlet gets a release from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octorelease Project</code> <para> Get all the releases for the project 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetRelease.Project"> <summary> <para type="description">The name of the project to get the release for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetRelease.ProjectId"> <summary> <para type="description">The id of the project to get the release for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetRelease.Version"> <summary> <para type="description">The version number of the release to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetRelease.ReleaseId"> <summary> <para type="description">The id of the release to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetRelease.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetRelease.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetStep"> <summary> <para type="synopsis">Get a deployment step for an Octopus Deploy project.</para> <para type="description">The Get-OctoStep cmdlet gets a deployment step for an Octopus Deploy project.</para> </summary> <example> <code>PS C:\>get-octostep Project</code> <para> Get all deployment steps for the project 'Project'. </para> </example> <example> <code>PS C:\>get-octostep -ProjectId projects-1</code> <para> Get all deployment steps for the project with the id 'projects-1'. </para> </example> <example> <code>PS C:\>get-octostep -DeploymentProcessId deploymentprocess-1</code> <para> Get all deployment steps for the deploymentprocess with the id 'projects-1'. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetStep.Project"> <summary> <para type="description">The name of the project to retrieve the step for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetStep.ProjectId"> <summary> <para type="description">The id of the project to retrieve the step for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetStep.DeploymentProcessId"> <summary> <para type="description">The id of the deployment process to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetStep.Name"> <summary> <para type="description">The name of the step to retrieve.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetStep.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetStep.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetVariable"> <summary> <para type="synopsis">Get a variable from the Octopus Deploy server.</para> <para type="description">The Get-OctoVariable cmdlet gets a variable from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octovariable Project</code> <para> Get all the variables for the project 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetVariable.Project"> <summary> <para type="description">The project to get the variables for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetVariable.Name"> <summary> <para type="description">The name of the variable to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetVariable.VariableSet"> <summary> <para type="description">The library variable set to get the variables for.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetVariable.VariableSetId"> <summary> <para type="description">"The id of the library variable set to get the variables for.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.GetVariableSet"> <summary> <para type="synopsis">Get a library variable set from the Octopus Deploy server.</para> <para type="description">The Get-OctoVariableSet cmdlet gets a library variable set from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>get-octovariableset</code> <para> Get all the variable sets. </para> </example> </member> <member name="P:Octopus_Cmdlets.GetVariableSet.Name"> <summary> <para type="description">The name of the variable set to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetVariableSet.Id"> <summary> <para type="description">The id of the variable set to retrieve.</para> </summary> </member> <member name="P:Octopus_Cmdlets.GetVariableSet.Cache"> <summary> <para type="description">Tells the command to load and cache all the variable sets.</para> </summary> </member> <member name="M:Octopus_Cmdlets.GetVariableSet.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.GetVariableSet.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.RemoveEnvironment"> <summary> <para type="synopsis">Remove an environment from the Octopus Deploy server.</para> <para type="description">The Remove-OctoEnvironment cmdlet removes an environment from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>remove-octoenvironment DEV</code> <para> Remove the environment named 'DEV'. </para> </example> </member> <member name="P:Octopus_Cmdlets.RemoveEnvironment.Name"> <summary> <para type="description">The name of the environment to remove.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveEnvironment.Id"> <summary> <para type="description">The id of the environment to remove.</para> </summary> </member> <member name="M:Octopus_Cmdlets.RemoveEnvironment.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.RemoveEnvironment.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.RemoveProject"> <summary> <para type="synopsis">Remove a project from the Octopus Deploy server.</para> <para type="description">The Remove-OctoProject cmdlet removes a project from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>remove-octoproject Project</code> <para> Remove the project named 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.RemoveProject.Name"> <summary> <para type="description">The name of the project to remove.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveProject.Id"> <summary> <para type="description">The id of the project to remove.</para> </summary> </member> <member name="M:Octopus_Cmdlets.RemoveProject.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.RemoveProject.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.RemoveProjectGroup"> <summary> <para type="synopsis">Remove a project group from the Octopus Deploy server.</para> <para type="description">The Remove-OctoProjectGroup cmdlet removes a project group from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>remove-octoprojectgroup Group</code> <para> Remove the project group named 'Group'. </para> </example> </member> <member name="P:Octopus_Cmdlets.RemoveProjectGroup.Name"> <summary> <para type="description">The name of the project group to remove.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveProjectGroup.Id"> <summary> <para type="description">The id of the project group to remove.</para> </summary> </member> <member name="M:Octopus_Cmdlets.RemoveProjectGroup.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.RemoveProjectGroup.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.RemoveVariable"> <summary> <para type="synopsis">Remove a variable from the Octopus Deploy server.</para> <para type="description">The Remove-OctoVariable cmdlet removes a variable from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>remove-octovariable Project Variable</code> <para> Remove the variable 'Variable' from the project 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.RemoveVariable.Project"> <summary> <para type="description">The name of the project to remove the variable from.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveVariable.Name"> <summary> <para type="description">The name of the variable to remove.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveVariable.InputObject"> <summary> <para type="description"> Specifies one or more variable objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects. </para> </summary> </member> <member name="M:Octopus_Cmdlets.RemoveVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.RemoveVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.RemoveVariable.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.RemoveVariableSet"> <summary> <para type="synopsis">Remove a variable set from the Octopus Deploy server.</para> <para type="description">The Remove-OctoVariableSet cmdlet removes a variable set from the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>remove-octovariableset VariableSet</code> <para> Remove the variableset 'VariableSet'. </para> </example> </member> <member name="P:Octopus_Cmdlets.RemoveVariableSet.Name"> <summary> <para type="description">The name of the library variable set to remove.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveVariableSet.Id"> <summary> <para type="description">The Id of the variable set to remove.</para> </summary> </member> <member name="P:Octopus_Cmdlets.RemoveVariableSet.InputObject"> <summary> <para type="description"> Specifies one or more library variableset objects. Enter a variable that contains the objects, or type a command or expressionthat gets the objects. </para> </summary> </member> <member name="M:Octopus_Cmdlets.RemoveVariableSet.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.RemoveVariableSet.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="T:Octopus_Cmdlets.UpdateLibraryVariable"> <summary> <para type="synopsis">Update an existing variable in an Octopus Deploy Library Variable Set.</para> <para type="description">The Update-OctoLibraryVariable cmdlet updates an existing variable in and Octopus Deploy Library Variable Set.</para> </summary> <example> <code>PS C:\>update-octolibraryvariable VariableSet variables-1 NewName</code> <para> Give the variable in the library variable set 'VariableSet', with the id 'variables-1', the name 'NewName'. </para> </example> <example> <code>PS C:\>update-octovariable -Project Project -Id variables-1 -Name NewName -Value "New Value" -Environments "DEV", "TEST"</code> <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. </para> </example> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.VariableSet"> <summary> <para type="description">The name of the library variable set containing the variable to update.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Id"> <summary> <para type="description">The id of the variable to update.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Name"> <summary> <para type="description">The new name of the variable.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Value"> <summary> <para type="description">The new value of the variable.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Environments"> <summary> <para type="description">The environments to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Roles"> <summary> <para type="description">The roles to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Machines"> <summary> <para type="description">The machines to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateLibraryVariable.Sensitive"> <summary> <para type="description">Specifies whether the variable is sensitive (value should be hidden).</para> </summary> </member> <member name="M:Octopus_Cmdlets.UpdateLibraryVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.UpdateLibraryVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.UpdateLibraryVariable.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.UpdateVariable"> <summary> <para type="synopsis">Update an existing variable in the Octopus Deploy server.</para> <para type="description">The Update-OctoVariable cmdlet updates an existing variable in the Octopus Deploy server.</para> </summary> <example> <code>PS C:\>update-octovariable Project variables-1 NewName</code> <para> Give the variable in the project 'Project', with the id 'variables-1', the name 'NewName'. </para> </example> <example> <code>PS C:\>update-octovariable -Project Project -Id variables-1 -Name NewName -Value "New Value" -Environments "DEV", "TEST"</code> <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. </para> </example> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Project"> <summary> <para type="description">The name of the project containing the variable to update.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Id"> <summary> <para type="description">The id of the variable to update.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Name"> <summary> <para type="description">The new name of the variable.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Value"> <summary> <para type="description">The new value of the variable.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Environments"> <summary> <para type="description">The environments to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Roles"> <summary> <para type="description">The roles to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Machines"> <summary> <para type="description">The machines to restrict the scope to.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UpdateVariable.Sensitive"> <summary> <para type="description">Specifies whether the variable is sensitive (value should be hidden).</para> </summary> </member> <member name="M:Octopus_Cmdlets.UpdateVariable.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.UpdateVariable.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.UpdateVariable.EndProcessing"> <summary> EndProcessing </summary> </member> <member name="T:Octopus_Cmdlets.UseVariableSet"> <summary> <para type="synopsis">Include a variable set in your project.</para> <para type="description">The Use-OctoVariableSet cmdlet includes a variable set in your project.</para> </summary> <example> <code>PS C:\>use-octovariableset Project VariableSet</code> <para> Include the library variable set 'VariableSet' in the project 'Project'. </para> </example> </member> <member name="P:Octopus_Cmdlets.UseVariableSet.Project"> <summary> <para type="description">The project to include the variable set into.</para> </summary> </member> <member name="P:Octopus_Cmdlets.UseVariableSet.Name"> <summary> <para type="description">The variable set names to include.</para> </summary> </member> <member name="M:Octopus_Cmdlets.UseVariableSet.BeginProcessing"> <summary> BeginProcessing </summary> </member> <member name="M:Octopus_Cmdlets.UseVariableSet.ProcessRecord"> <summary> ProcessRecord </summary> </member> <member name="M:Octopus_Cmdlets.UseVariableSet.EndProcessing"> <summary> EndProcessing </summary> </member> </members> </doc> |