ControlUp.Automation.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Install-CUAgent --> <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>Install-CUAgent</command:name> <command:verb>Install</command:verb> <command:noun>CUAgent</command:noun> <maml:description> <maml:para>The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Install-CUAgent</maml:name> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token used to authenticate the user and organization.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstallationDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>InstallationDirectory</maml:name> <maml:description> <maml:para>The installation path which the agent will be installed to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specifies the folder path in the organization tree where the machine should be placed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstallAgentManager --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>InstallAgentManager</maml:name> <maml:description> <maml:para>Specifies whether to install the agent Manager (currently not supported)</maml:para> </maml:description> <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: Site --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Site</maml:name> <maml:description> <maml:para>The name or ID of the Monitor Site which the agent should be assigned to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BrokeringMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>BrokeringMode</maml:name> <maml:description> <maml:para>Sets the brokering mode. 'Online' indicates that the agent should automatically retrieve a PAT from the backend.</maml:para> <maml:para>Possible values: Online, Offline</maml:para> </maml:description> <command:parameterValue required="true">BrokeringMode</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.BrokeringMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Online</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Online</command:parameterValue> <command:parameterValue required="false" variableLength="false">Offline</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MonitorFQDNs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>MonitorFQDNs</maml:name> <maml:description> <maml:para>An array of fully qualified domain names (FQDNs) for the monitors that the agent will communicate with.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyToMonitor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>ProxyToMonitor</maml:name> <maml:description> <maml:para>For outbound agents only: The proxy server to be used for communicating with the monitor.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyToControlUpBackend --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>ProxyToControlUpBackend</maml:name> <maml:description> <maml:para>For outbound agents only: The proxy server to be used for communicating with the ControlUp backend.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Specifies the connection type for the agent.</maml:para> <maml:para>Possible values: Outbound, Inbound</maml:para> </maml:description> <command:parameterValue required="true">AgentConnection</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.Interfaces.AgentConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Outbound</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Outbound</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inbound</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ZipFilePath</maml:name> <maml:description> <maml:para>The file path to the ZIP containing the ControlUp agent binaries. This ZIP can be downloaded from the ControlUp Download Center at https://www.controlup.com/products/controlup/download-center/.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of the agent to install. If omitted, the latest version from the ControlUp Download Center is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProxySettings</maml:name> <maml:description> <maml:para>Proxy settings for configuring this agent installation.</maml:para> </maml:description> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: AgentRegistrationKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AgentRegistrationKey</maml:name> <maml:description> <maml:para>"For outbound agents only: Registration key to enable agents to connect outbound".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AgentPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AgentPort</maml:name> <maml:description> <maml:para>The port number used by the agent for incoming monitor connections.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AgentAuthenticationKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AgentAuthenticationKey</maml:name> <maml:description> <maml:para>The authentication key which is required to enable incoming traffic from console and monitors</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstallAsMasterImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>InstallAsMasterImage</maml:name> <maml:description> <maml:para>Relevant for outbound agents only: Mark this agent machine as a master image.</maml:para> </maml:description> <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: AddFirewallRule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AddFirewallRule</maml:name> <maml:description> <maml:para>Determines if a Windows firewall rule should be added in the registry (Inbound port 40705).</maml:para> </maml:description> <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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token used to authenticate the user and organization.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ZipFilePath</maml:name> <maml:description> <maml:para>The file path to the ZIP containing the ControlUp agent binaries. This ZIP can be downloaded from the ControlUp Download Center at https://www.controlup.com/products/controlup/download-center/.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version of the agent to install. If omitted, the latest version from the ControlUp Download Center is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>ProxySettings</maml:name> <maml:description> <maml:para>Proxy settings for configuring this agent installation.</maml:para> </maml:description> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: AgentRegistrationKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>AgentRegistrationKey</maml:name> <maml:description> <maml:para>"For outbound agents only: Registration key to enable agents to connect outbound".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AgentPort --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AgentPort</maml:name> <maml:description> <maml:para>The port number used by the agent for incoming monitor connections.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AgentAuthenticationKey --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>AgentAuthenticationKey</maml:name> <maml:description> <maml:para>The authentication key which is required to enable incoming traffic from console and monitors</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstallAsMasterImage --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>InstallAsMasterImage</maml:name> <maml:description> <maml:para>Relevant for outbound agents only: Mark this agent machine as a master image.</maml:para> </maml:description> <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: AddFirewallRule --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>AddFirewallRule</maml:name> <maml:description> <maml:para>Determines if a Windows firewall rule should be added in the registry (Inbound port 40705).</maml:para> </maml:description> <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: InstallationDirectory --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>InstallationDirectory</maml:name> <maml:description> <maml:para>The installation path which the agent will be installed to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InstallAgentManager --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>InstallAgentManager</maml:name> <maml:description> <maml:para>Specifies whether to install the agent Manager (currently not supported)</maml:para> </maml:description> <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: FolderPath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Specifies the folder path in the organization tree where the machine should be placed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Site --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Site</maml:name> <maml:description> <maml:para>The name or ID of the Monitor Site which the agent should be assigned to.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BrokeringMode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>BrokeringMode</maml:name> <maml:description> <maml:para>Sets the brokering mode. 'Online' indicates that the agent should automatically retrieve a PAT from the backend.</maml:para> <maml:para>Possible values: Online, Offline</maml:para> </maml:description> <command:parameterValue required="true">BrokeringMode</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.BrokeringMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Online</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Online</command:parameterValue> <command:parameterValue required="false" variableLength="false">Offline</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: MonitorFQDNs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>MonitorFQDNs</maml:name> <maml:description> <maml:para>An array of fully qualified domain names (FQDNs) for the monitors that the agent will communicate with.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyToMonitor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>ProxyToMonitor</maml:name> <maml:description> <maml:para>For outbound agents only: The proxy server to be used for communicating with the monitor.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxyToControlUpBackend --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>ProxyToControlUpBackend</maml:name> <maml:description> <maml:para>For outbound agents only: The proxy server to be used for communicating with the ControlUp backend.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ConnectionType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>ConnectionType</maml:name> <maml:description> <maml:para>Specifies the connection type for the agent.</maml:para> <maml:para>Possible values: Outbound, Inbound</maml:para> </maml:description> <command:parameterValue required="true">AgentConnection</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.Interfaces.AgentConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Outbound</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Outbound</command:parameterValue> <command:parameterValue required="false" variableLength="false">Inbound</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Uninstall-CUAgent --> <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>Uninstall-CUAgent</command:name> <command:verb>Uninstall</command:verb> <command:noun>CUAgent</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Uninstall-CUAgent</maml:name> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token that is used to identify the user and the organization on which the installed agent.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProxyToControlUpBackend --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProxyToControlUpBackend</maml:name> <maml:description> <maml:para>Proxy To ControlUpBackend.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemainOnOrgTree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RemainOnOrgTree</maml:name> <maml:description> <maml:para>Use to Remain Agent On Organization Tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token that is used to identify the user and the organization on which the installed agent.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Force</maml:name> <maml:description> <maml:para>Force.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ProxyToControlUpBackend --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProxyToControlUpBackend</maml:name> <maml:description> <maml:para>Proxy To ControlUpBackend.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemainOnOrgTree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RemainOnOrgTree</maml:name> <maml:description> <maml:para>Use to Remain Agent On Organization Tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Invoke-CUAgentUpdate --> <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>Invoke-CUAgentUpdate</command:name> <command:verb>Invoke</command:verb> <command:noun>CUAgentUpdate</command:noun> <maml:description> <maml:para>The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-CUAgentUpdate</maml:name> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ZipFilePath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProxySettings</maml:name> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DeployManager --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeployManager</maml:name> <command:parameterValue required="true">IDeployManager`1</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.IDeployManager`1[[DeployAgentInputParams, ControlUp.Automation, Version=1.0.3.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ZipFilePath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProxySettings</maml:name> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DeployManager --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DeployManager</maml:name> <command:parameterValue required="true">IDeployManager`1</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.IDeployManager`1[[DeployAgentInputParams, ControlUp.Automation, Version=1.0.3.0, Culture=neutral, PublicKeyToken=null]]</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-CUAPIProfile --> <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-CUAPIProfile</command:name> <command:verb>Get</command:verb> <command:noun>CUAPIProfile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CUAPIProfile</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Set-CUAPIProfile --> <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>Set-CUAPIProfile</command:name> <command:verb>Set</command:verb> <command:noun>CUAPIProfile</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CUAPIProfile</maml:name> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Profile</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Profile</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Set-CUAPIToken --> <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>Set-CUAPIToken</command:name> <command:verb>Set</command:verb> <command:noun>CUAPIToken</command:noun> <maml:description> <maml:para>Safely stores the API token you retrieved from DEX within a specified profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Safely stores the API token you retrieved from DEX (app.controlup.com) within a specified profile, ensuring that the token is securely encrypted using the Data Protection API (DPAPI) and is accessible only by the user account under which the cmdlet is executed. The encrypted token is Base64-encoded and stored at %appdata%\ControlUp\.cuapi. This cmdlet requires the -Token parameter for the API token and optionally accepts a -Profile parameter to define the storage profile. If you don't provide a profile name, the Default profile is taken.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Set-CUAPIToken</maml:name> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token to be stored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Define the storage profile. If you don't provide a profile name, the Default profile is taken.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token to be stored.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Profile --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Profile</maml:name> <maml:description> <maml:para>Define the storage profile. If you don't provide a profile name, the Default profile is taken.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The DEX API Token to be stored.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Define the storage profile. If you don't provide a profile name, the Default profile is taken.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Install-CUMonitor --> <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>Install-CUMonitor</command:name> <command:verb>Install</command:verb> <command:noun>CUMonitor</command:noun> <maml:description> <maml:para>The Install-CUMonitor cmdlets allows you to install a new ControlUp Monitor on the local machine.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Install-CUMonitor cmdlets allows you to install a new ControlUp Monitor on the local machine.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Install-CUMonitor</maml:name> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PublicDNSName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>PublicDNSName</maml:name> <maml:description> <maml:para>The public DNS name that ControlUp agents that communicate outbound need to reach.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InternalDNSName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>InternalDNSName</maml:name> <maml:description> <maml:para>The DNS name of the installed monitor that needs to be access by all other installed monitors in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Certificate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The path to the certificate file (e.g., .pfx) used for Advanced Authentication. See https://support.controlup.com/docs/certificate-based-console-and-installed monitor-authentication for more details.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CertificatePassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>The password that is used to protect the private key of this certificate.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PerformSignatureCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>PerformSignatureCheck</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> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ZipFilePath</maml:name> <maml:description> <maml:para>The path of the ZIP file containing the ControlUp installed monitor binaries. The ZIP file can be downloaded in the ControlUp download center under https://www.controlup.com/products/controlup/download-center/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the installed monitor version. If omitted, the latest version from the ControlUp Download Center is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The name of the ControlUp installed monitor Site in which the installed monitor should be deployed. Will be automatically created if not exist.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Template</maml:name> <maml:description> <maml:para>The installed monitor template which should be used to configure this installed monitor. If omitted, all will be selected.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ProxySettings</maml:name> <maml:description> <maml:para>ProxySettings that should be configured for this installed monitor.</maml:para> </maml:description> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DomainDns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>DomainDns</maml:name> <maml:description> <maml:para>The FQDN of the new domain AD connection. Will be attached to -SiteName if provided.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DomainUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>DomainUser</maml:name> <maml:description> <maml:para>Adds a domain user to the AD connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DomainUserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DomainUserPassword</maml:name> <maml:description> <maml:para>The password of the domain user you define in the -DomainUser parameter.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Token</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ZipFilePath</maml:name> <maml:description> <maml:para>The path of the ZIP file containing the ControlUp installed monitor binaries. The ZIP file can be downloaded in the ControlUp download center under https://www.controlup.com/products/controlup/download-center/</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the installed monitor version. If omitted, the latest version from the ControlUp Download Center is used.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>The name of the ControlUp installed monitor Site in which the installed monitor should be deployed. Will be automatically created if not exist.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Template --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Template</maml:name> <maml:description> <maml:para>The installed monitor template which should be used to configure this installed monitor. If omitted, all will be selected.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>ProxySettings</maml:name> <maml:description> <maml:para>ProxySettings that should be configured for this installed monitor.</maml:para> </maml:description> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DomainDns --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>DomainDns</maml:name> <maml:description> <maml:para>The FQDN of the new domain AD connection. Will be attached to -SiteName if provided.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DomainUser --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>DomainUser</maml:name> <maml:description> <maml:para>Adds a domain user to the AD connection.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DomainUserPassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>DomainUserPassword</maml:name> <maml:description> <maml:para>The password of the domain user you define in the -DomainUser parameter.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PublicDNSName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>PublicDNSName</maml:name> <maml:description> <maml:para>The public DNS name that ControlUp agents that communicate outbound need to reach.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: InternalDNSName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>InternalDNSName</maml:name> <maml:description> <maml:para>The DNS name of the installed monitor that needs to be access by all other installed monitors in the cluster.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Certificate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>Certificate</maml:name> <maml:description> <maml:para>The path to the certificate file (e.g., .pfx) used for Advanced Authentication. See https://support.controlup.com/docs/certificate-based-console-and-installed monitor-authentication for more details.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CertificatePassword --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>CertificatePassword</maml:name> <maml:description> <maml:para>The password that is used to protect the private key of this certificate.</maml:para> </maml:description> <command:parameterValue required="true">SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: PerformSignatureCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>PerformSignatureCheck</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:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Uninstall-CUMonitor --> <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>Uninstall-CUMonitor</command:name> <command:verb>Uninstall</command:verb> <command:noun>CUMonitor</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Uninstall-CUMonitor</maml:name> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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> <!-- Parameter: DoNotPerformOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DoNotPerformOnAgent</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> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token that is used to identify the user and the organization on which the installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemainOnOrgTree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RemainOnOrgTree</maml:name> <maml:description> <maml:para>Use to Remain Agent On Organization Tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <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> <!-- Parameter: DoNotPerformOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>DoNotPerformOnAgent</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> <!-- Parameter: Token --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Token</maml:name> <maml:description> <maml:para>The DEX API Token that is used to identify the user and the organization on which the installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RemainOnOrgTree --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>RemainOnOrgTree</maml:name> <maml:description> <maml:para>Use to Remain Agent On Organization Tree.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Invoke-CUMonitorUpdate --> <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>Invoke-CUMonitorUpdate</command:name> <command:verb>Invoke</command:verb> <command:noun>CUMonitorUpdate</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-CUMonitorUpdate</maml:name> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ZipFilePath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProxySettings</maml:name> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DoNotPerformOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DoNotPerformOnAgent</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> <!-- Parameter: NoRollback --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NoRollback</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> <!-- Parameter: PerformSignatureCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>PerformSignatureCheck</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:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ZipFilePath --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>ZipFilePath</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Version</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ProxySettings --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>ProxySettings</maml:name> <command:parameterValue required="true">ProxySettings</command:parameterValue> <dev:type> <maml:name>ControlUp.Automation.ProxySettings</maml:name> <maml:uri /> <maml:description> <maml:para>This is part of the type description.</maml:para> <maml:para>This is also part of the type description.</maml:para> </maml:description> </dev:type> </command:parameter> <!-- Parameter: DoNotPerformOnAgent --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>DoNotPerformOnAgent</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> <!-- Parameter: NoRollback --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>NoRollback</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> <!-- Parameter: PerformSignatureCheck --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>PerformSignatureCheck</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:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-CUProxySettings --> <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-CUProxySettings</command:name> <command:verb>Get</command:verb> <command:noun>CUProxySettings</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-CUProxySettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Find-Util --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Find-Util</command:name> <command:verb>Find</command:verb> <command:noun>Util</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Find-Util</maml:name> <!-- Parameter: Key --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key parameter which allowed to run only from .VBS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MonitorFromConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MonitorFromConfiguration</maml:name> <maml:description> <maml:para>Util to remove Monitor From Configuration, for internal purpose only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Key --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Key</maml:name> <maml:description> <maml:para>Key parameter which allowed to run only from .VBS.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MonitorFromConfiguration --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MonitorFromConfiguration</maml:name> <maml:description> <maml:para>Util to remove Monitor From Configuration, for internal purpose only.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> </helpItems> |