ControlUp.PowerShell.User.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Add-CUComputer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-CUComputer</command:name> <command:verb>Add</command:verb> <command:noun>CUComputer</command:noun> <maml:description> <maml:para>Adds a computer to ControlUp real-time Console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a computer account from Active Directory to ControlUp real-time Console.</maml:para> <maml:para>ADComputerName describes the computer account name as appears in Active Directory.</maml:para> <maml:para>DomainName describes the domain name from which the computer will be added.</maml:para> <maml:para>FolderPath describes the ControlUp folder path to which the computer will be added.</maml:para> <maml:para>DnsName is optional for explicitly writing the DNS name of the computer.</maml:para> <maml:para>SiteId is optional for specifying the ControlUp site Id.</maml:para> <maml:para>Batch instance is optional in case using a batch mode.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-CUComputer</maml:name> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="DomainName"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="ADComputerName"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>DnsName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>SiteId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="ADComputerName"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="DomainName"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DnsName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>DnsName</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>SiteId</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="6"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-CUComputer -ADComputerName “PC001” -DomainName “NTNET” -FolderPath “\SQL Servers”</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$b = New-CUBatchUpdate</maml:para> <maml:para>Add-CUComputer -Name PC002 -Domain NTNET -FolderPath “\SQL Servers” -Batch $b</maml:para> <maml:para>Add-CUComputer -Name PC003 -Domain NTNET -FolderPath “\SQL Servers” -Batch $b</maml:para> <maml:para>Add-CUComputer -Name PC004 -Domain NTNET.local -DnsName PC004.SomeDNSName.com -FolderPath “\SQL Servers” -Batch $b</maml:para> <maml:para>Publish-CUUpdates $b</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$b = New-CUBatchUpdate</maml:para> <maml:para>Search-CUComputersFromAD -Domain NTNET -Name *SQLSRV* | Add-CUComputer -FolderPath “\SQL Servers” -Batch $b</maml:para> <maml:para>Publish-CUUpdates $b</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-CUComputer</maml:linkText> <maml:linkText>New-CUBatchUpdate</maml:linkText> <maml:linkText>Publish-CUUpdates</maml:linkText> <maml:linkText>Search-CUComputersFromAD</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Remove-CUComputer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CUComputer</command:name> <command:verb>Remove</command:verb> <command:noun>CUComputer</command:noun> <maml:description> <maml:para>Removes a computer from ControlUp real-time Console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a computer from ControlUp real-time Console.</maml:para> <maml:para>Name indicates the computer that will be removed from ControlUp real-time Console.</maml:para> <maml:para>Batch instance is optional in case using a batch mode.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CUComputer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Force</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="ADComputerName"> <maml:name>Name</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Force</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Batch --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-CUComputer -Name “John-PC”</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$b = New-CUBatchUpdate</maml:para> <maml:para>Remove-CUComputer -Name “John-PC” -Batch $b</maml:para> <maml:para>Remove-CUComputer -Name “Jane-PC” -Batch $b</maml:para> <maml:para>Publish-CUUpdates $b</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>$b = New-CUBatchUpdate</maml:para> <maml:para>Get-CUComputers -FolderPath “\SQL Servers” -Match SQLSRV | Remove-CUComputer -Batch $b</maml:para> <maml:para>Publish-CUUpdates $b</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Add-CUFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Add-CUFolder</command:name> <command:verb>Add</command:verb> <command:noun>CUFolder</command:noun> <maml:description> <maml:para>Adds a folder to ControlUp real-time Console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a folder to ControlUp real-time Console. Folder name is specified by the -Name parameter, and its parent location by the -ParentPath parameter. If -ParentPath is not specified, the new folder will be created under the root folder.</maml:para> <maml:para>Optional parameters - ExcludeFromMonitor determines whether the folder contents will be excluded from connection by ControlUp Monitor services.If this parameter is not specified, its values will be inherited from the parent folder.</maml:para> <maml:para>For batch mode, use the Batch option</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Add-CUFolder</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ParentPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeFromMonitor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ExcludeFromMonitor</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParentPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>ParentPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Description --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Description</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeFromMonitor --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4"> <maml:name>ExcludeFromMonitor</maml:name> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="5"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Add-CUFolder -Name “SQL Servers” will create a folder named “SQL Servers” under the organization root folder.</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Add-CUFolder -Name “Production” -ParentPath “Organization Name\SQL Servers” will create a folder named “Production” under the SQL Servers folder.</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Add-CUFolder -Name “Test” -ParentPath “Organization Name\SQL Servers” -Description “Test SQL Servers” -ExcludeFromMonitor $True will create a folder named “Test” under the SQL Servers folder with the specified description, will instruct ControlUp to exclude this folder from monitor connections.</maml:para> </maml:introduction> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-CUFolder</maml:linkText> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para> The following characters are allowed: letters, numbers, space, dash and underscore. </maml:para> <maml:para></maml:para> </maml:alert> <maml:alert> <maml:para> The following folder names are reserved and cannot be used: “Hypervisors”, “Cloud Connections”, “XenDesktop Sites”. </maml:para> <maml:para></maml:para> </maml:alert> </maml:alertSet> </command:command> <!-- Cmdlet: Remove-CUFolder --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Remove-CUFolder</command:name> <command:verb>Remove</command:verb> <command:noun>CUFolder</command:noun> <maml:description> <maml:para>Removes a folder from ControlUp real-time Console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a folder from ControlUp real-time Console. Folder path is specified by the -FolderPath parameter.</maml:para> <maml:para>Optional parameter - Force ignores any validation questions.</maml:para> <maml:para>For batch mode, use the Batch option</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Remove-CUFolder</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Remove-CUFolder -FolderPath “MyFirstCUFolder” -ParentPath “Organization Name” </maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Remove-CUFolder -FolderPath “MySecondCUFolder” -ParentPath “Organization Name\XD Folders”</maml:para> </maml:introduction> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Remove-CUFolder -FolderPath “MyThirsCUFolder” -ParentPath “Organization Name” -Force True</maml:para> </maml:introduction> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-CUFolder</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Move-CUComputer --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Move-CUComputer</command:name> <command:verb>Move</command:verb> <command:noun>CUComputer</command:noun> <maml:description> <maml:para>Moves a computer between ControlUp folders.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Moves a computer between ControlUp folders. Name indicates the computer that will be moved from current location to -NewFolderPath which determines the new location in ControlUp real-time Console.</maml:para> <maml:para>For batch mode, use the Batch option</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Move-CUComputer</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>FolderPath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>Batch</maml:name> <command:parameterValue required="true">BatchUpdate</command:parameterValue> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>ControlUp.PowerShell.User.Cmdlets.BatchUpdate</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Move-CUComputer -Name “John-PC” -NewFolderPath “\Servers\Boston”.</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-CUFolder</maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-CUComputers --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-CUComputers</command:name> <command:verb>Get</command:verb> <command:noun>CUComputers</command:noun> <maml:description> <maml:para>Gets the ControlUp (windows) computers in the organization configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configured ControlUp windows agents. Optional parameters are for getting the computers under a folder subtree using the -FolderPath option, and using the -Match for limiting the results using a regex filter.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CUComputers</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Match</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>FolderPath</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Match</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Get-CUComputers -FolderPath “\SQL Servers” -Match SQLSRV</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Search-CUComputersFromAD --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Search-CUComputersFromAD</command:name> <command:verb>Search</command:verb> <command:noun>CUComputersFromAD</command:noun> <maml:description> <maml:para>Query AD for computer accounts that can be added to ControlUp</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Query AD the for computers returning with the attributes ControlUp requires (Netbios and dnsHostName). The result set can be piped to Add-CUComputer (use batch when adding large amount of computers) </maml:para> <maml:para>Name is the search string on computers name. Wildcards are supported. </maml:para> <maml:para>Domain is the AD domain FQDN or netbios name. This domain must be configured on ControlUp.</maml:para> <maml:para>OU is optional and offers the ability to limit the search.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Search-CUComputersFromAD</maml:name> <!-- Parameter: FolderPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3"> <maml:name>OU</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Name</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Domain --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Domain</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OU --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>OU</maml:name> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Search-CUComputersFromAD -Domain NTNET -Name *SQLSRV* -OU "CN=Computers,DC=ntnet,DC=local"</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>$b = New-CUBatchUpdate</maml:para> <maml:para>Search-CUComputersFromAD -Domain NTNET -Name *SQLSRV* | Add-CUComputer -FolderPath “\SQL Servers” -Batch $b</maml:para> <maml:para>Publish-CUUpdates $b</maml:para> </maml:introduction> <dev:code></dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText></maml:linkText> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |