en-US/ConfluencePS-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <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-Label</command:name> <command:verb>Add</command:verb> <command:noun>Label</command:noun> <maml:description><maml:para>Add a new global label to an existing Confluence page. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Assign labels (one or more) to Confluence pages (one or more). If the label did not exist previously, it will be created. Preexisting labels are not affected. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-Label</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The ID of the page to which apply the label to. Accepts multiple IDs, including via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-Info. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="named" aliases="Labels"><maml:name>Label</maml:name> <maml:Description><maml:para>One or more labels to be added. Currently only supports labels of prefix "global". </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-Info. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The ID of the page to which apply the label to. Accepts multiple IDs, including via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</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="named" aliases="Labels"><maml:name>Label</maml:name> <maml:Description><maml:para>One or more labels to be added. Currently only supports labels of prefix "global". </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.ContentLabelSet</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>Add-ConfluenceLabel -PageID 123456 -Label alpha -Verbose</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Apply the label alpha to the wiki page with ID 123456. -Verbose output provides extra technical details, if interested. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluencePage -SpaceKey SRV | Add-ConfluenceLabel -Label servers -WhatIf</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Simulates applying the label "servers" to all pages in the space with key SRV. -WhatIf provides PageIDs of pages that would have been affected. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ConfluencePage -SpaceKey DEMO | Add-ConfluenceLabel -Label abc -Confirm</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Applies the label "abc" to all pages in the space with key DEMO. -Confirm prompts Yes/No for each page that would be affected. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Add-Label.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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>ConvertTo-StorageFormat</command:name> <command:verb>ConvertTo</command:verb> <command:noun>StorageFormat</command:noun> <maml:description><maml:para>Convert your content to Confluence's storage format. </maml:para> </maml:description> </command:details> <maml:description><maml:para>To properly create/edit pages, content should be in the proper "XHTML-based" format. Invokes a POST call to convert from a "wiki" representation, receiving a "storage" response. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>ConvertTo-StorageFormat</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Content</maml:name> <maml:Description><maml:para>A string (in plain text and/or wiki markup) to be converted to storage format. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Content</maml:name> <maml:Description><maml:para>A string (in plain text and/or wiki markup) to be converted to storage format. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.String</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>$Body = ConvertTo-ConfluenceStorageFormat -Content 'Hello world!'</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Stores the returned value '<p>Hello world!</p>' in $Body for use in New-ConfluencePage/Set-ConfluencePage/etc. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-Date -Format s | ConvertTo-ConfluenceStorageFormat</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Pipe the current date/time in sortable format, returning the converted string. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/ConvertTo-StorageFormat.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Confluence Storage Format</maml:linkText> <maml:uri>https://confluence.atlassian.com/confcloud/confluence-storage-format-724765084.html</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>ConvertTo-Table</command:name> <command:verb>ConvertTo</command:verb> <command:noun>Table</command:noun> <maml:description><maml:para>Convert your content to Confluence's wiki markup table format. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Formats input as a table with a horizontal header row. This wiki formatting is an intermediate step, and would still need ConvertTo-ConfluenceStorageFormat called against it. </maml:para> <maml:para>This work is performed locally, and does not perform a REST call. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>ConvertTo-Table</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"><maml:name>Content</maml:name> <maml:Description><maml:para>The object array you would like to see displayed as a table on a wiki page. </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>NoHeader</maml:name> <maml:Description><maml:para>Ignore the property names, keeping a table of values with no header row highlighting. </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 (ByValue)" position="1" aliases="none"><maml:name>Content</maml:name> <maml:Description><maml:para>The object array you would like to see displayed as a table on a wiki page. </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>NoHeader</maml:name> <maml:Description><maml:para>Ignore the property names, keeping a table of values with no header row highlighting. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>Basically stolen verbatim from thomykay's PoshConfluence SOAP API module. See links section. </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-Service | Select Name,DisplayName,Status -First 10 | ConvertTo-ConfluenceTable</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>List the first ten services on your computer, and convert to a table in Confluence markup format. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$SvcTable = Get-Service | Select Name,Status -First 10 | ConvertTo-ConfluenceTable | ConvertTo-ConfluenceStorageFormat</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Following Example 1, convert the table from wiki markup format into storage format. Store the results in $SvcTable for a later New-ConfluencePage/etc. command. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-Alias | Where {$_.Name.Length -eq 1} | Select CommandType,DisplayName | ConvertTo-ConfluenceTable -NoHeader</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Make a table of all one-character PowerShell aliases, and don't include the header row. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/ConvertTo-Table.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>thomykay PoshConfluence</maml:linkText> <maml:uri>https://github.com/thomykay/PoshConfluence</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-ChildPage</command:name> <command:verb>Get</command:verb> <command:noun>ChildPage</command:noun> <maml:description><maml:para>Retrieve the child pages of a given wiki page or pages. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Return all pages directly below the given page(s). Optionally, the -Recurse parameter will return all child pages, no matter how nested. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-ChildPage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>Filter results by page ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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>Recurse</maml:name> <maml:Description><maml:para>Get all child pages recursively </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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>Filter results by page ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Recurse</maml:name> <maml:Description><maml:para>Get all child pages recursively </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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.Page</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para>Confluence uses hierarchy to help organize content. This command is meant to help provide the intended context from the command line. </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-ConfluenceChildPage -PageID 123456 Get-ConfluencePage -PageID 123456 | Get-ConfluenceChildPage</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Two different methods to return all pages directly below page 123456. Both examples should return identical results. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluenceChildPage -PageID 123456 -Recurse</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Instead of returning only 123456's child pages, return grandchildren, great-grandchildren, and so on. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Get-ChildPage.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Label</command:name> <command:verb>Get</command:verb> <command:noun>Label</command:noun> <maml:description><maml:para>Retrieve all labels applied to the given object(s). </maml:para> </maml:description> </command:details> <maml:description><maml:para>Currently, this command only returns a label list from wiki pages. It is intended to eventually support other content types as well. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-Label</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>List the PageID number to check for labels. Accepts piped input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>List the PageID number to check for labels. Accepts piped input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.ContentLabelSet</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-ConfluenceLabel -PageID 123456</dev:code> <dev:remarks><maml:para>Returns all labels applied to wiki page 123456. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluencePage -SpaceKey HOTH -Label skywalker | Get-ConfluenceLabel</dev:code> <dev:remarks><maml:para>For all pages in HOTH with the "skywalker" label applied, return the full list of labels found on each page. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Get-Label.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Page</command:name> <command:verb>Get</command:verb> <command:noun>Page</command:noun> <maml:description><maml:para>Retrieve a listing of pages in your Confluence instance. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Return Confluence pages, filtered by ID, Name, or Space. Piped output into other cmdlets is generally tested and supported. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>Filter results by page ID. Best option if you already know the ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="Name"><maml:name>Title</maml:name> <maml:Description><maml:para>Filter results by page name (case-insensitive). This supports wildcards (*) to allow for partial matching. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Filter results by space key (case-insensitive). </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="False" position="named" aliases="none"><maml:name>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="Name"><maml:name>Title</maml:name> <maml:Description><maml:para>Filter results by page name (case-insensitive). This supports wildcards (*) to allow for partial matching. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Filter results by space key (case-insensitive). </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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none"><maml:name>Space</maml:name> <maml:Description><maml:para>Filter results by space object(s), typically from the pipeline. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Filter results by space key (case-insensitive). </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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Space</maml:name> <maml:Description><maml:para>Filter results by space object(s), typically from the pipeline. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Label</maml:name> <maml:Description><maml:para>Filter results to only pages with the specified label(s). </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="False" position="named" aliases="none"><maml:name>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ApiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>Filter results by page ID. Best option if you already know the ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="named" aliases="Name"><maml:name>Title</maml:name> <maml:Description><maml:para>Filter results by page name (case-insensitive). This supports wildcards (*) to allow for partial matching. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Filter results by space key (case-insensitive). </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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>Space</maml:name> <maml:Description><maml:para>Filter results by space object(s), typically from the pipeline. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Label</maml:name> <maml:Description><maml:para>Filter results to only pages with the specified label(s). </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="False" position="named" aliases="none"><maml:name>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many things will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.Page</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-ConfluencePage -SpaceKey HOTH Get-ConfluenceSpace -SpaceKey HOTH | Get-ConfluencePage</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Two different methods to return all wiki pages in space "HOTH". Both examples should return identical results. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluencePage -PageID 123456 | Format-List *</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Returns the wiki page with ID 123456. `Format-List *` displays all of the object's properties, including the full page body. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ConfluencePage -Title 'luke*' -SpaceKey HOTH</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Return all pages in HOTH whose names start with "luke" (case-insensitive). Wildcards (*) can be inserted to support partial matching. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-ConfluencePage -Label 'skywalker'</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Return all pages containing the label "skywalker" (case-insensitive). Label text must match exactly; no wildcards are applied. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Get-Page.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Space</command:name> <command:verb>Get</command:verb> <command:noun>Space</command:noun> <maml:description><maml:para>Retrieve a listing of spaces in your Confluence instance. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Return all Confluence spaces, optionally filtering by Key. Piped output into other cmdlets is generally tested and supported. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-Space</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Filter results by key. Supports wildcard matching on partial input. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many objects will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Filter results by key. Supports wildcard matching on partial input. </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="False" position="named" aliases="none"><maml:name>PageSize</maml:name> <maml:Description><maml:para>Maximum number of results to fetch per call. This setting can be tuned to get better performance according to the load on the server. Warning: too high of a PageSize can cause a timeout on the request. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>25</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>IncludeTotalCount</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Causes an extra output of the total count at the beginning. Note this is actually a uInt64, but with a custom string representation. </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>Skip</maml:name> <maml:Description><maml:para>Controls how many objects will be skipped before starting output. Defaults to 0. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>First</maml:name> <maml:Description><maml:para>NOTE: Not yet implemented. Indicates how many items to return. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt64</command:parameterValue> <dev:type><maml:name>UInt64</maml:name> <maml:uri /></dev:type> <dev:defaultValue>18446744073709551615</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes></command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.Space</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-ConfluenceSpace</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Display the info of all spaces on the server. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluenceSpace -SpaceKey HOTH | Format-List *</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Return only the space with key "HOTH" (case-insensitive). `Format-List *` displays all of the object's properties. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ConfluenceSpace -ApiURi "https://myserver.com/wiki" -Credential $cred</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Manually specifying a server and authentication credentials, list all spaces found on the instance. `Set-ConfluenceInfo` usually makes this unnecessary, unless you are actively maintaining multiple instances. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Get-Space.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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>New-Page</command:name> <command:verb>New</command:verb> <command:noun>Page</command:noun> <maml:description><maml:para>Create a new page on your Confluence instance. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Create a new page on Confluence. </maml:para> <maml:para>Optionally include content in -Body. Body content needs to be in "Confluence storage format" -- see also -Convert. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>InputObject</maml:name> <maml:Description><maml:para>A ConfluencePS.Page object from which to create a new page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:syntaxItem><maml:name>New-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Name"><maml:name>Title</maml:name> <maml:Description><maml:para>Name of your new page. </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="False" position="named" aliases="none"><maml:name>ParentID</maml:name> <maml:Description><maml:para>The ID of the parent page. NOTE: This feature is not in the 5.8 REST API documentation, and should be considered experimental. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Parent</maml:name> <maml:Description><maml:para>Supply a ConfluencePS.Page object to use as the parent page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</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>SpaceKey</maml:name> <maml:Description><maml:para>Key of the space where the new page should exist. Only needed if you don't specify a parent page. </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="False" position="named" aliases="none"><maml:name>Space</maml:name> <maml:Description><maml:para>Space Object in which to create the new page. Only needed if you don't specify a parent page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</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>Body</maml:name> <maml:Description><maml:para>The contents of your new page. </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="False" position="named" aliases="none"><maml:name>Convert</maml:name> <maml:Description><maml:para>Optionally, convert the provided body to Confluence's storage format. Has the same effect as calling ConvertTo-ConfluenceStorageFormat against your Body. </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>InputObject</maml:name> <maml:Description><maml:para>A ConfluencePS.Page object from which to create a new page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Name"><maml:name>Title</maml:name> <maml:Description><maml:para>Name of your new page. </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="False" position="named" aliases="none"><maml:name>ParentID</maml:name> <maml:Description><maml:para>The ID of the parent page. NOTE: This feature is not in the 5.8 REST API documentation, and should be considered experimental. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Parent</maml:name> <maml:Description><maml:para>Supply a ConfluencePS.Page object to use as the parent page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</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>SpaceKey</maml:name> <maml:Description><maml:para>Key of the space where the new page should exist. Only needed if you don't specify a parent page. </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="False" position="named" aliases="none"><maml:name>Space</maml:name> <maml:Description><maml:para>Space Object in which to create the new page. Only needed if you don't specify a parent page. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</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>Body</maml:name> <maml:Description><maml:para>The contents of your new page. </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="False" position="named" aliases="none"><maml:name>Convert</maml:name> <maml:Description><maml:para>Optionally, convert the provided body to Confluence's storage format. Has the same effect as calling ConvertTo-ConfluenceStorageFormat against your Body. </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.Page</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>New-ConfluencePage -Title 'Test New Page' -SpaceKey asdf</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Create a new blank wiki page at the root of space "asdf". </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-ConfluencePage -Title 'Luke Skywalker' -Parent (Get-ConfluencePage -Title 'Darth Vader' -SpaceKey 'STARWARS')</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Creates a new blank wiki page as a child page below "Darth Vader" in the specified space. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>New-ConfluencePage -Title 'Luke Skywalker' -ParentID 123456 -Verbose</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Creates a new blank wiki page as a child page below the wiki page with ID 123456. -Verbose provides extra technical details, if interested. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>New-ConfluencePage -Title 'foo' -SpaceKey 'bar' -Body $PageContents</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Create a new wiki page named 'foo' at the root of space 'bar'. The wiki page will contain the data stored in $PageContents. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>New-ConfluencePage -Title 'foo' -SpaceKey 'bar' -Body 'Testing 123' -Convert</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Create a new wiki page named 'foo' at the root of space 'bar'. The wiki page will contain the text "Testing 123". -Convert will condition the -Body parameter's string into storage format. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>$pageObject = [ConfluencePS.Page]@{ Title = "My Title" Space = [ConfluencePS.Space]@{ Key="ABC" } } New-ConfluencePage -InputObject $pageObject $pageObject | New-ConfluencePage</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Two different methods of creating a new page from an object `ConfluencePS.Page`. Both examples should return identical results. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/New-Page.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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>New-Space</command:name> <command:verb>New</command:verb> <command:noun>Space</command:noun> <maml:description><maml:para>Create a new blank space on your Confluence instance. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Create a new blank space. Key and Name mandatory, Description recommended. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-Space</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>InputObject</maml:name> <maml:Description><maml:para>Space Object from which to create the new space. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:syntaxItem><maml:name>New-Space</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Specify the short key to be used in the space URI. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specify the space's name. </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="False" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>A short description of the new space. </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="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>InputObject</maml:name> <maml:Description><maml:para>Space Object from which to create the new space. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Space</command:parameterValue> <dev:type><maml:name>Space</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>Specify the short key to be used in the space URI. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specify the space's name. </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="False" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>A short description of the new space. </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="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.Space</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>New-ConfluenceSpace -Key 'HOTH' -Name 'Planet Hoth' -Description "It's really cold" -Verbose</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Create a new blank space with an optional description and verbose output. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$spaceObject = [ConfluencePS.Space]@{ Key = "HOTH" Name = "Planet Hoth" Description = "It's really cold" } New-ConfluenceSpace -InputObject $spaceObject $spaceObject | New-ConfluenceSpace</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Two different methods of creating a new space from an object `ConfluencePS.Space`. Both examples should return identical results. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/New-Space.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Label</command:name> <command:verb>Remove</command:verb> <command:noun>Label</command:noun> <maml:description><maml:para>Remove a label from existing Confluence content. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Remove labels from Confluence content. Does accept multiple pages piped via Get-ConfluencePage. Untested against non-page content. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-Label</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The page ID to remove the label from. Accepts multiple IDs via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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>Label</maml:name> <maml:Description><maml:para>A single content label to remove from one or more pages. </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="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The page ID to remove the label from. Accepts multiple IDs via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</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>Label</maml:name> <maml:Description><maml:para>A single content label to remove from one or more pages. </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="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</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>Remove-ConfluenceLabel -PageID 123456 -Label 'seven' -Verbose -Confirm</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Remove label "seven" from the wiki page with ID 123456. Verbose and Confirm flags both active; you will be prompted before deletion. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluencePage -SpaceKey 'ABC' -Label 'asdf' | Remove-ConfluenceLabel -Label 'asdf' -WhatIf</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For all wiki pages in the ABC space, the label "asdf" would be removed. WhatIf parameter prevents any modifications. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ConfluenceChildPage -PageID 123456 | Remove-ConfluenceLabel</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For all wiki pages immediately below page 123456, remove all labels from each page. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Remove-Label.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Page</command:name> <command:verb>Remove</command:verb> <command:noun>Page</command:noun> <maml:description><maml:para>Trash an existing Confluence page. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Delete existing Confluence content by page ID. This trashes most content, but will permanently delete "un-trashable" content. Untested against non-page content. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The page ID to delete. Accepts multiple IDs via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The page ID to delete. Accepts multiple IDs via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</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>Remove-ConfluencePage -PageID 123456 -Verbose -Confirm</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Trash the wiki page with ID 123456. Verbose and Confirm flags both active; you will be prompted before removal. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluencePage -SpaceKey ABC -Title '*test*' | Remove-ConfluencePage -WhatIf</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For all wiki pages in space ABC with "test" somewhere in the name, simulate the each page being trashed. -WhatIf prevents any removals. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ConfluencePage -Label 'deleteme' | Remove-ConfluencePage</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For all wiki pages with the label "deleteme" applied, trash each page. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Remove-Page.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Space</command:name> <command:verb>Remove</command:verb> <command:noun>Space</command:noun> <maml:description><maml:para>Remove an existing Confluence space. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Delete an existing Confluence space, including child content. "The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns." </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-Space</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>The key (short code) of the space to delete. Accepts multiple keys via pipeline input. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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>Force</maml:name> <maml:Description><maml:para>Forces the deletion of the space without prompting for confirmation. </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="Key"><maml:name>SpaceKey</maml:name> <maml:Description><maml:para>The key (short code) of the space to delete. Accepts multiple keys via pipeline input. </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="False" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Forces the deletion of the space without prompting for confirmation. </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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</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>Remove-ConfluenceSpace -SpaceKey ABC -WhatIf</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Simulates the deletion of wiki space ABC and all child content. -WhatIf parameter prevents removal of content. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Remove-ConfluenceSpace -SpaceKey XYZ -Force</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Delete wiki space XYZ and all child content below it. By default, you will be prompted to confirm removal. ("Are you sure? Y/N") -Force suppresses all confirmation prompts and carries out the deletion. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Remove-Space.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Info</command:name> <command:verb>Set</command:verb> <command:noun>Info</command:noun> <maml:description><maml:para>Specify wiki location and authorization for use in this session's REST API requests. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Set-ConfluenceInfo uses scoped variables and PSDefaultParameterValues to supply URI/auth info to all other functions in the module (e.g. Get-ConfluenceSpace). These session defaults can be overwritten on any single command, but using Set-ConfluenceInfo avoids repetitively specifying -ApiUri and -Credential parameters. </maml:para> <maml:para>Confluence's REST API supports passing basic authentication in headers. (If you have a better suggestion for how to handle auth, please reach out on GitHub!) </maml:para> <maml:para>Unless allowing anonymous access to your instance, credentials are needed. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-Info</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"><maml:name>BaseURi</maml:name> <maml:Description><maml:para>Address of your base Confluence install. For Atlassian Cloud instances, include /wiki. </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="False" position="2" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>The username/password combo you use to log in to Confluence. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>PageSize</maml:name> <maml:Description><maml:para>Default PageSize for the invocations. More info in the Notes field of this help file. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PromptCredentials</maml:name> <maml:Description><maml:para>Prompt the user for credentials </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="false" pipelineInput="False" position="1" aliases="none"><maml:name>BaseURi</maml:name> <maml:Description><maml:para>Address of your base Confluence install. For Atlassian Cloud instances, include /wiki. </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="False" position="2" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>The username/password combo you use to log in to Confluence. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>PageSize</maml:name> <maml:Description><maml:para>Default PageSize for the invocations. More info in the Notes field of this help file. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PromptCredentials</maml:name> <maml:Description><maml:para>Prompt the user for credentials </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:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para>The default page size for all commands is 25. Using the -PageSize parameter changes the default for all commands in your current session. </maml:para> <maml:para>Tweaking PageSize can help improve pipeline performance when returning many objects. See related links for implementation discussion and details. </maml:para> <maml:para>(If you don't know exactly what this means, feel free to ignore it.) </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-ConfluenceInfo -BaseURI 'https://yournamehere.atlassian.net/wiki' -PromptCredentials</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Declare the URI of your Confluence instance; be prompted for username and password. Note that Atlassian Cloud Confluence instances typically use the /wiki subdirectory. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-ConfluenceInfo -BaseURI 'https://wiki.yourcompany.com'</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Declare the URI of your Confluence instance. You will not be prompted for credentials, and other commands would attempt to connect anonymously with read-only permissions. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Set-ConfluenceInfo -BaseURI 'https://wiki.contoso.com' -PromptCredentials -PageSize 50</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Declare the URI of your Confluence instance; be prompted for username and password. Set the default "page size" for all your commands in this session to 50 (see Notes). </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>$Cred = Get-Credential Set-ConfluenceInfo -BaseURI 'https://wiki.yourcompany.com' -Credential $Cred</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Declare the URI of your Confluence instance and the credentials (username and password). </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Set-Info.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS/issues/50</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/issues/50</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS/pull/59</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/pull/59</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-Label</command:name> <command:verb>Set</command:verb> <command:noun>Label</command:noun> <maml:description><maml:para>Set the labels applied to existing Confluence content. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Sets desired labels for Confluence content. (Currently, Set-ConfluenceLabel only supports interacting with wiki pages.) All preexisting labels will be removed in the process. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-Label</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The page ID to remove the label from. Accepts multiple IDs via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Label</maml:name> <maml:Description><maml:para>Label names to add to the content. </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="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</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="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The page ID to remove the label from. Accepts multiple IDs via pipeline input. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Label</maml:name> <maml:Description><maml:para>Label names to add to the content. </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="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.ContentLabelSet</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-ConfluenceLabel -PageID 123456 -Label 'a','b','c'</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For existing wiki page with ID 123456, remove all labels, then add the three specified. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-ConfluencePage -SpaceKey 'ABC' | Set-Label -Label '123' -WhatIf</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Would remove all labels and apply only the label "123" to all pages in the ABC space. -WhatIf reports on simulated changes, but does not modifying anything. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Set-Label.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</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-Page</command:name> <command:verb>Set</command:verb> <command:noun>Page</command:noun> <maml:description><maml:para>Edit an existing Confluence page. </maml:para> </maml:description> </command:details> <maml:description><maml:para>For existing page(s): Edit page content, page title, and/or change parent page. Content needs to be in "Confluence storage format." Use -Convert if not preconditioned. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>InputObject</maml:name> <maml:Description><maml:para>Page Object which will be used to replace the current content. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:syntaxItem><maml:name>Set-Page</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The ID of the page to edit. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Name of the page; existing or new value can be used. Existing will be automatically supplied via Get-Page if not manually included. </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="False" position="named" aliases="none"><maml:name>Body</maml:name> <maml:Description><maml:para>The full contents of the updated body (existing contents will be overwritten). If not yet in "storage format"--or you don't know what that is--also use -Convert. </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="False" position="named" aliases="none"><maml:name>Convert</maml:name> <maml:Description><maml:para>Optional switch flag for calling ConvertTo-ConfluenceStorageFormat against your Body. </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>ParentID</maml:name> <maml:Description><maml:para>Optionally define a new parent page. If unspecified, no change. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Parent</maml:name> <maml:Description><maml:para>Optionally define a new parent page. If unspecified, no change. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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="False" position="named" aliases="none"><maml:name>apiURi</maml:name> <maml:Description><maml:para>The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo. </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="False" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"><maml:name>InputObject</maml:name> <maml:Description><maml:para>Page Object which will be used to replace the current content. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="ID"><maml:name>PageID</maml:name> <maml:Description><maml:para>The ID of the page to edit. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Name of the page; existing or new value can be used. Existing will be automatically supplied via Get-Page if not manually included. </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="False" position="named" aliases="none"><maml:name>Body</maml:name> <maml:Description><maml:para>The full contents of the updated body (existing contents will be overwritten). If not yet in "storage format"--or you don't know what that is--also use -Convert. </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="False" position="named" aliases="none"><maml:name>Convert</maml:name> <maml:Description><maml:para>Optional switch flag for calling ConvertTo-ConfluenceStorageFormat against your Body. </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>ParentID</maml:name> <maml:Description><maml:para>Optionally define a new parent page. If unspecified, no change. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Parent</maml:name> <maml:Description><maml:para>Optionally define a new parent page. If unspecified, no change. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Page</command:parameterValue> <dev:type><maml:name>Page</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="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </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="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </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:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>ConfluencePS.Page</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-ConfluencePage -PageID 123456 -Title 'Counting'</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For existing wiki page 123456, change its name to "Counting". </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-ConfluencePage -PageID 123456 -Body 'Hello World!' -Convert</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>For existing wiki page 123456, update its page contents to "Hello World!" -Convert applies the "Confluence storage format" to your given string. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Set-ConfluencePage -PageID 123456 -ParentID 654321 Set-ConfluencePage -PageID 123456 -Parent (Get-ConfluencePage -PageID 654321)</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Two different methods to set a new parent page. Parent page 654321 will now have child page 123456. </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>$page = Get-ConfluencePage -PageID 123456 $page.Title = "New Title" Set-ConfluencePage -InputObject $page $page | Set-ConfluencePage</dev:code> <dev:remarks><maml:para>Description </maml:para> <maml:para>----------- </maml:para> <maml:para>Two different methods to set a new parent page using a `ConfluencePS.Page` object. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS/blob/master/docs/en-US/Set-Page.md</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>https://github.com/AtlassianPS/ConfluencePS</maml:linkText> <maml:uri>https://github.com/AtlassianPS/ConfluencePS</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |