ControlUp.Automation.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>ControlUp.Automation</name> </assembly> <members> <member name="T:ControlUp.Automation.CmdLets.Agent.DeployAgent"> <summary> <para type="synopsis">The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine. </para> <para type="description">The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine. </para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.Token"> <summary> <para type="description">The DEX API Token used to authenticate the user and organization.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.ZipFilePath"> <summary> <para type="description">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/.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.Version"> <summary> <para type="description">Specifies the version of the agent to install. If omitted, the latest version from the ControlUp Download Center is used.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.ProxySettings"> <summary> <para type="description">Proxy settings for configuring this agent installation.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.AgentRegistrationKey"> <summary> <para type="description">"For outbound agents only: Registration key to enable agents to connect outbound".</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.AgentPort"> <summary> <para type="description">The port number used by the agent for incoming monitor connections.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.AgentAuthenticationKey"> <summary> <para type="description">The authentication key which is required to enable incoming traffic from console and monitors</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.InstallAsMasterImage"> <summary> <para type="description">Relevant for outbound agents only: Mark this agent machine as a master image.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.AddFirewallRule"> <summary> <para type="description">Determines if a Windows firewall rule should be added in the registry (Inbound port 40705).</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.InstallationDirectory"> <summary> <para type="description">The installation path which the agent will be installed to.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.InstallAgentManager"> <summary> <para type="description">Specifies whether to install the agent Manager (currently not supported)</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.FolderPath"> <summary> <para type="description">Specifies the folder path in the organization tree where the machine should be placed.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.Site"> <summary> <para type="description">The name or ID of the Monitor Site which the agent should be assigned to.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.BrokeringMode"> <summary> <para type="description">Sets the brokering mode. 'Online' indicates that the agent should automatically retrieve a PAT from the backend.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.MonitorFQDNs"> <summary> <para type="description">An array of fully qualified domain names (FQDNs) for the monitors that the agent will communicate with.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.ProxyToMonitor"> <summary> <para type="description">For outbound agents only: The proxy server to be used for communicating with the monitor.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.ProxyToControlUpBackend"> <summary> <para type="description">For outbound agents only: The proxy server to be used for communicating with the ControlUp backend.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.DeployAgent.ConnectionType"> <summary> <para type="description">Specifies the connection type for the agent.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.UninstallAgent.Token"> <summary> <para type="description">The DEX API Token that is used to identify the user and the organization on which the installed agent.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.UninstallAgent.Force"> <summary> <para type="description">Force.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.UninstallAgent.ProxyToControlUpBackend"> <summary> <para type="description">Proxy To ControlUpBackend.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Agent.UninstallAgent.RemainOnOrgTree"> <summary> <para type="description">Use to Remain Agent On Organization Tree.</para> </summary> </member> <member name="T:ControlUp.Automation.CmdLets.Agent.UpdateAgent"> <summary> <para type="synopsis">The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine. </para> <para type="description">The Install-CUAgent cmdlets allows you to install a new ControlUp Agent on the local machine. </para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Utils.Key"> <summary> <para type="description">Key parameter which allowed to run only from .VBS.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Utils.MonitorFromConfiguration"> <summary> <para type="description">Util to remove Monitor From Configuration, for internal purpose only.</para> </summary> </member> <member name="T:ControlUp.Automation.CmdLets.SetApiToken"> <summary> <para type="synopsis">Safely stores the API token you retrieved from DEX within a specified profile. </para> <para type="description">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.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.SetApiToken.Token"> <summary> <para type="description">The DEX API Token to be stored.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.SetApiToken.Profile"> <summary> <para type="description">Define the storage profile. If you don't provide a profile name, the Default profile is taken.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.UninstallMonitor.Token"> <summary> <para type="description">The DEX API Token that is used to identify the user and the organization on which the installed.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.UninstallMonitor.RemainOnOrgTree"> <summary> <para type="description">Use to Remain Agent On Organization Tree.</para> </summary> </member> <member name="T:ControlUp.Automation.CmdLets.Monitor.DeployMonitor"> <summary> <para type="synopsis">The Install-CUMonitor cmdlets allows you to install a new ControlUp Monitor on the local machine. </para> <para type="description">The Install-CUMonitor cmdlets allows you to install a new ControlUp Monitor on the local machine. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.Token" --> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.ZipFilePath"> <summary> <para type="description">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/</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.Version"> <summary> <para type="description">Specifies the installed monitor version. If omitted, the latest version from the ControlUp Download Center is used.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.SiteName"> <summary> <para type="description">The name of the ControlUp installed monitor Site in which the installed monitor should be deployed. Will be automatically created if not exist.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.Template"> <summary> <para type="description">The installed monitor template which should be used to configure this installed monitor. If omitted, all will be selected.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.ProxySettings"> <summary> <para type="description">ProxySettings that should be configured for this installed monitor.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.DomainDns"> <summary> <para type="description">The FQDN of the new domain AD connection. Will be attached to -SiteName if provided.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.DomainUser"> <summary> <para type="description">Adds a domain user to the AD connection.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.DomainUserPassword"> <summary> <para type="description">The password of the domain user you define in the -DomainUser parameter.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.PublicDNSName"> <summary> <para type="description">The public DNS name that ControlUp agents that communicate outbound need to reach.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.InternalDNSName"> <summary> <para type="description">The DNS name of the installed monitor that needs to be access by all other installed monitors in the cluster.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.Certificate"> <summary> <para type="description">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.</para> </summary> </member> <member name="P:ControlUp.Automation.CmdLets.Monitor.DeployMonitor.CertificatePassword"> <summary> <para type="description">The password that is used to protect the private key of this certificate.</para> </summary> </member> <member name="M:ControlUp.Automation.Helpers.RetryHelper.RetryOnExceptionAsync``1(System.Int32,System.Func{System.Threading.Tasks.Task{``0}})"> <summary> Retries the given operation a specified number of times. </summary> <typeparam name="T">The type of the result of the operation.</typeparam> <param name="times">The number of times to retry the operation.</param> <param name="operation">The operation to retry.</param> <returns>The result of the operation if it is successful; otherwise, the default value of type T.</returns> <exception cref="T:System.Exception">The exception thrown by the operation if all retry attempts fail.</exception> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_QUERY_CONFIG"> <summary> Required to call the QueryServiceConfig and QueryServiceConfig2 functions to query the service configuration. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_CHANGE_CONFIG"> <summary> Required to call the ChangeServiceConfig or ChangeServiceConfig2 function to change the service configuration. Because this grants the caller the right to change the executable file that the system runs, it should be granted only to administrators. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_QUERY_STATUS"> <summary> Required to call the QueryServiceStatusEx function to ask the service control manager about the status of the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_ENUMERATE_DEPENDENTS"> <summary> Required to call the EnumDependentServices function to enumerate all the services dependent on the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_START"> <summary> Required to call the StartService function to start the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_STOP"> <summary> Required to call the ControlService function to stop the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_PAUSE_CONTINUE"> <summary> Required to call the ControlService function to pause or continue the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_INTERROGATE"> <summary> Required to call the EnumDependentServices function to enumerate all the services dependent on the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_USER_DEFINED_CONTROL"> <summary> Required to call the ControlService function to specify a user-defined control code. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.SERVICE_ALL_ACCESS"> <summary> Includes STANDARD_RIGHTS_REQUIRED in addition to all access rights in this table. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.ACCESS_SYSTEM_SECURITY"> <summary> Required to call the QueryServiceObjectSecurity or SetServiceObjectSecurity function to access the SACL. The proper way to obtain this access is to enable the SE_SECURITY_NAME privilege in the caller's current access token, open the handle for ACCESS_SYSTEM_SECURITY access, and then disable the privilege. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.DELETE"> <summary> Required to call the DeleteService function to delete the service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.READ_CONTROL"> <summary> Required to call the QueryServiceObjectSecurity function to query the security descriptor of the service object. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.WRITE_DAC"> <summary> Required to call the SetServiceObjectSecurity function to modify the Dacl member of the service object's security descriptor. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ACCESS.WRITE_OWNER"> <summary> Required to call the SetServiceObjectSecurity function to modify the Owner and Group members of the service object's security descriptor. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_TYPE.SERVICE_KERNEL_DRIVER"> <summary> Driver service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_TYPE.SERVICE_FILE_SYSTEM_DRIVER"> <summary> File system driver service. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_TYPE.SERVICE_WIN32_OWN_PROCESS"> <summary> Service that runs in its own process. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_TYPE.SERVICE_WIN32_SHARE_PROCESS"> <summary> Service that shares a process with one or more other services. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_TYPE.SERVICE_INTERACTIVE_PROCESS"> <summary> The service can interact with the desktop. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_START.SERVICE_BOOT_START"> <summary> A device driver started by the system loader. This value is valid only for driver services. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_START.SERVICE_SYSTEM_START"> <summary> A device driver started by the IoInitSystem function. This value is valid only for driver services. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_START.SERVICE_AUTO_START"> <summary> A service started automatically by the service control manager during system startup. For more information, see Automatically Starting Services. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_START.SERVICE_DEMAND_START"> <summary> A service started by the service control manager when a process calls the StartService function. For more information, see Starting Services on Demand. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_START.SERVICE_DISABLED"> <summary> A service that cannot be started. Attempts to start the service result in the error code ERROR_SERVICE_DISABLED. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ERROR.SERVICE_ERROR_IGNORE"> <summary> The startup program ignores the error and continues the startup operation. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ERROR.SERVICE_ERROR_NORMAL"> <summary> The startup program logs the error in the event log but continues the startup operation. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ERROR.SERVICE_ERROR_SEVERE"> <summary> The startup program logs the error in the event log. If the last-known-good configuration is being started, the startup operation continues. Otherwise, the system is restarted with the last-known-good configuration. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.SERVICE_ERROR.SERVICE_ERROR_CRITICAL"> <summary> The startup program logs the error in the event log, if possible. If the last-known-good configuration is being started, the startup operation fails. Otherwise, the system is restarted with the last-known good configuration. </summary> </member> <member name="F:ControlUp.Automation.Helpers.sxServiceInstaller.ENUM_SERVICE_STATUS_PROCESS.SizePack8"> <summary> sizeof(ENUM_SERVICE_STATUS_PROCESS) allow Packing of 8 on 64 bit machines </summary> </member> <member name="T:ControlUp.Automation.ProxySettings"> <summary> <para type="description">This is part of the type description.</para> <para type="description">This is also part of the type description.</para> </summary> </member> <member name="T:ControlUp.Automation.AuthenticationScheme"> <summary> <para type="description">This is part of the type description.</para> <para type="description">This is also part of the type description.</para> </summary> </member> </members> </doc> |