en-US/AtlassianPS.Configuration-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ServerConfiguration</command:name> <command:verb>Add</command:verb> <command:noun>ServerConfiguration</command:noun> <maml:description> <maml:para>Stores a new Server entry for the module to known with what server it should talk to.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function allows for several Server object to be stored in memory. Stored servers are used by the commands in order to know with what server to communicate.</maml:para> <maml:para>The stored servers can be exported to file with Export-Configuration (../Export-Configuration/). Exported servers will be imported automatically when the module is loaded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ServerConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Url, Address"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>Address of the Server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name with which this server will be stored.</maml:para> <maml:para>If no name is provided, the "Authority" of the address will be used. This value must be unique.</maml:para> <maml:para>In case the ServerName was already saved, it will be overwritten.</maml:para> <maml:para>Example for "Authority": https:// www.google.com /maps?hl=en --> "www.google.com"</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Uri.Authority</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Type of the server to store.</maml:para> <maml:para>This can be:</maml:para> <maml:para>* Bitbucket</maml:para> <maml:para>* Confluence</maml:para> <maml:para>* Jira</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">BITBUCKET</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CONFLUENCE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JIRA</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ServerType</command:parameterValue> <dev:type> <maml:name>ServerType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>Session</maml:name> <maml:Description> <maml:para>Stores a WebSession to the server object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WebRequestSession</command:parameterValue> <dev:type> <maml:name>WebRequestSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"> <maml:name>Headers</maml:name> <maml:Description> <maml:para>Stores the Headers that should be used for this server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Url, Address"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>Address of the Server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name with which this server will be stored.</maml:para> <maml:para>If no name is provided, the "Authority" of the address will be used. This value must be unique.</maml:para> <maml:para>In case the ServerName was already saved, it will be overwritten.</maml:para> <maml:para>Example for "Authority": https:// www.google.com /maps?hl=en --> "www.google.com"</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$Uri.Authority</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Type of the server to store.</maml:para> <maml:para>This can be:</maml:para> <maml:para>* Bitbucket</maml:para> <maml:para>* Confluence</maml:para> <maml:para>* Jira</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ServerType</command:parameterValue> <dev:type> <maml:name>ServerType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>Session</maml:name> <maml:Description> <maml:para>Stores a WebSession to the server object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WebRequestSession</command:parameterValue> <dev:type> <maml:name>WebRequestSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"> <maml:name>Headers</maml:name> <maml:Description> <maml:para>Stores the Headers that should be used for this server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Add-AtlassianServerConfiguration -Uri "https://server.com/" -Name "Server Prod" -Type "Jira"</dev:code> <dev:remarks> <maml:para>This command will store the Jira server address and name in memory and allow other commands to identify the server by the name "Server Prod"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Add-AtlassianServerConfiguration -Uri "https://server.com/" -Type "Jira"</dev:code> <dev:remarks> <maml:para>This command will store the Jira server address with the name "server.com" in memory and allow other commands to identify the server by the name "Server Prod"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Add-ServerConfiguration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AtlassianPS.ServerData</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-Configuration</command:name> <command:verb>Export</command:verb> <command:noun>Configuration</command:noun> <maml:description> <maml:para>Store the server configuration to disk</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This allows to store the Servers stored in the module's memory to disk. By doing this, the module will load the servers back into memory every time it is loaded. Sessions are not stored when exported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-Configuration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>This functionality uses PoshCode/Configuration (https://github.com/PoshCode/Configuration).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Add-AtlassianServerConfiguration -Uri "https://atlassian.net" -Type Confluence Export-AtlassianConfiguration</dev:code> <dev:remarks> <maml:para>Stores the server to disk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Export-Configuration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Configuration</command:name> <command:verb>Get</command:verb> <command:noun>Configuration</command:noun> <maml:description> <maml:para>Retrieve a stored configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve a stored configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Configuration</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the configuration to be retrieved</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueOnly</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet gets only the value of the variable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the configuration to be retrieved</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ValueOnly</maml:name> <maml:Description> <maml:para>Indicates that this cmdlet gets only the value of the variable.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[System.Management.Automation.PSObject]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-AtlassianConfiguration</dev:code> <dev:remarks> <maml:para>Get all stored servers</maml:para> <maml:para>> Each entry is returned as a PSCustomObject where the `Name` is the name of the > entry and the `Value` is it's value. > This is used for using the pipleline. See Example 4. > Use `-ValueOnly` if interested only in the value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-AtlassianConfiguration -Name "Headers" -Value @{ Authorization = "Basic ABCDEF" } Get-AtlassianConfiguration -Name "Headers"</dev:code> <dev:remarks> <maml:para>Get a specific entry in the configuration.</maml:para> <maml:para>> Each entry is returned as a PSCustomObject where the `Name` is the name of the > entry and the `Value` is it's value. > This is used for using the pipeline. See Example 4. > Use `-ValueOnly` if interested only in the value.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Set-AtlassianConfiguration -Name "Headers" -Value @{ Authorization = "Basic ABCDEF" } Get-AtlassianConfiguration -Name "Headers" -ValueOnly</dev:code> <dev:remarks> <maml:para>Get the value of a specific entry in the configuration.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Set-AtlassianConfiguration -Name "Headers" -Value @{ Authorization = "Basic ABCDEF" } Set-AtlassianConfiguration -Name "SomethingElse" -Value (Get-Date) "Headers", "SomethingElse", "SomethingMissing" | Get-AtlassianConfiguration | Set-AtlassianConfiguration -Value $null</dev:code> <dev:remarks> <maml:para>> Command is spread across multiple lines to be easier to read</maml:para> <maml:para>This example uses the pipeline twice:</maml:para> <maml:para>1. The `-Name` of the entry is passed from the three string 2. The `-Name` of the two entries found are passed to `Set-AtlassianConfigration` 3. `Set-AtlassianConfigration` resets the value of the two entries</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Get-Configuration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ServerConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>ServerConfiguration</command:noun> <maml:description> <maml:para>Get the data of a stored server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieve the stored servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ServerConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Url, Address"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>Address of the stored server.</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ServerConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the server that was defined when stored.</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Url, Address"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>Address of the stored server.</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the server that was defined when stored.</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[AtlassianPS.ServerData]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-AtlassianServerConfiguration</dev:code> <dev:remarks> <maml:para>Get all stored servers</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-AtlassianServerConfiguration -Name "prod"</dev:code> <dev:remarks> <maml:para>Get the data of the server with Name "prod"</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-AtlassianServerConfiguration -Uri "https://myserver.com"</dev:code> <dev:remarks> <maml:para>Get the data of the server with address "https://myserver.com"</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Get-ServerConfiguration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AtlassianPS.ServerData</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-Configuration</command:name> <command:verb>Remove</command:verb> <command:noun>Configuration</command:noun> <maml:description> <maml:para>Remove a configuration entry.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove a configuration entry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Configuration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name under which the value is stored</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name under which the value is stored</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-AtlassianConfiguration -Name "Headers"</dev:code> <dev:remarks> <maml:para>This command will remove "Headers" configuration.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Remove-Configuration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ServerConfiguration</command:name> <command:verb>Remove</command:verb> <command:noun>ServerConfiguration</command:noun> <maml:description> <maml:para>Remove a Stores Server from memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function allows for several Server object to be removed in memory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ServerConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name with which this server is stored.</maml:para> <maml:para>Is case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name with which this server is stored.</maml:para> <maml:para>Is case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-AtlassianServerConfiguration -Name "Server Prod"</dev:code> <dev:remarks> <maml:para>Remove "Server Prod" from the list of stored servers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-AtlassianServerConfiguration | Remove-AtlassianServerConfiguration</dev:code> <dev:remarks> <maml:para>This command will remove all stored servers.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Remove-ServerConfiguration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Configuration</command:name> <command:verb>Set</command:verb> <command:noun>Configuration</command:noun> <maml:description> <maml:para>Stores a key/value pair to the configuration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stores a key/value pair to the configuration.</maml:para> <maml:para>This is only available in the current sessions, unless exported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Configuration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name under which to store the value</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>Value to store</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Append</maml:name> <maml:Description> <maml:para>Append Value to existing data</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Passthru</maml:name> <maml:Description> <maml:para>Whether output should be provided after invoking this function</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name under which to store the value</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>Value to store</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Append</maml:name> <maml:Description> <maml:para>Append Value to existing data</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Passthru</maml:name> <maml:Description> <maml:para>Whether output should be provided after invoking this function</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>[PSCustomObject]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-AtlassianConfiguration -Name "Headers" -Value @{Accept = "application/json"}</dev:code> <dev:remarks> <maml:para>This command will store a new Header configuration</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Set-Configuration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ServerConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>ServerConfiguration</command:noun> <maml:description> <maml:para>Updates a stores Server entry.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function provides the means to change a stored server entry.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ServerConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier (index) of the entry to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Url, Address"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>Address of the Server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name with which this server will be stored.</maml:para> <maml:para>If no name is provided, the "Authority" of the address will be used. This value must be unique.</maml:para> <maml:para>In case the ServerName was already saved, it will be overwritten.</maml:para> <maml:para>Example for "Authority": https:// www.google.com /maps?hl=en --> "www.google.com"</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Type of the server to store.</maml:para> <maml:para>This can be:</maml:para> <maml:para>* Bitbucket</maml:para> <maml:para>* Confluence</maml:para> <maml:para>* Jira</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">BITBUCKET</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CONFLUENCE</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JIRA</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ServerType</command:parameterValue> <dev:type> <maml:name>ServerType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"> <maml:name>Session</maml:name> <maml:Description> <maml:para>Stores a WebSession to the server object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WebRequestSession</command:parameterValue> <dev:type> <maml:name>WebRequestSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>Headers</maml:name> <maml:Description> <maml:para>Stores the Headers that should be used for this server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>Identifier (index) of the entry to update</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="2" aliases="Url, Address"> <maml:name>Uri</maml:name> <maml:Description> <maml:para>Address of the Server.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Uri</command:parameterValue> <dev:type> <maml:name>Uri</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="ServerName, Alias"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name with which this server will be stored.</maml:para> <maml:para>If no name is provided, the "Authority" of the address will be used. This value must be unique.</maml:para> <maml:para>In case the ServerName was already saved, it will be overwritten.</maml:para> <maml:para>Example for "Authority": https:// www.google.com /maps?hl=en --> "www.google.com"</maml:para> <maml:para>Is not case sensitive</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Type of the server to store.</maml:para> <maml:para>This can be:</maml:para> <maml:para>* Bitbucket</maml:para> <maml:para>* Confluence</maml:para> <maml:para>* Jira</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ServerType</command:parameterValue> <dev:type> <maml:name>ServerType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="5" aliases="none"> <maml:name>Session</maml:name> <maml:Description> <maml:para>Stores a WebSession to the server object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WebRequestSession</command:parameterValue> <dev:type> <maml:name>WebRequestSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>Headers</maml:name> <maml:Description> <maml:para>Stores the Headers that should be used for this server</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Add-AtlassianServerConfiguration -Uri "https://server.com/" -Type "Confluence" Set-AtlassianServerConfiguration -Id 1 -Uri "https://atlassian.net"</dev:code> <dev:remarks> <maml:para>This command will replace the Uri stored of the first entry of the stored servers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Add-AtlassianServerConfiguration -Name "My Server" -Uri "https://server.com/" -Type "Jira" Set-AtlassianServerConfiguration -Id 1 -Name "wiki" -Type "Confluence"</dev:code> <dev:remarks> <maml:para>This command will replace the Name and Type of the first entry of the stored servers.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Add-AtlassianServerConfiguration -Name "JiraServer" -Uri "https://server.com/" -Type "Jira" Get-AtlassianServerConfiguration | Where Type -eq "JIRA" | Set-AtlassianServerConfiguration -Uri "https://atlassian.net"</dev:code> <dev:remarks> <maml:para>This command will replace the Uri of all stored Jira servers with the new address.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://atlassianps.org/docs/AtlassianPS.Configuration/commands/Set-ServerConfiguration/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>AtlassianPS.ServerData</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-ServerConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-Configuration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |