ControlUp.Automation.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>ControlUp.Automation</name> </assembly> <members> <member name="T:ControlUp.PowerShell.Common.APIToken.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.PowerShell.Common.APIToken.SetApiToken.Token"> <summary> <para type="description">The DEX API Token to be stored.</para> </summary> </member> <member name="P:ControlUp.PowerShell.Common.APIToken.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="T:ControlUp.Automation.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> <member name="P:ControlUp.Automation.DeployMonitor.Token"> <summary> <para type="description">The DEX API Token that is used to identify the user and the organization on which the monitor should be installed.</para> </summary> </member> <member name="P:ControlUp.Automation.DeployMonitor.ZipFilePath"> <summary> <para type="description">The path of the ZIP file containing the ControlUp 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.DeployMonitor.Version"> <summary> <para type="description">Specifies the monitor version. If omitted, the latest version from the ControlUp Download Center is used.</para> </summary> </member> <member name="P:ControlUp.Automation.DeployMonitor.SiteName"> <summary> <para type="description">The name of the ControlUp Monitor Site in which the monitor should be deployed. Will be automatically created if not exist.</para> </summary> </member> <member name="P:ControlUp.Automation.DeployMonitor.Template"> <summary> <para type="description">The Monitor template which should be used to configure this monitor. If omitted, all will be selected.</para> </summary> </member> <member name="P:ControlUp.Automation.DeployMonitor.ProxySettings"> <summary> <para type="description">ProxySettings that should be configured for this monitor.</para> </summary> </member> <member name="P:ControlUp.Automation.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.DeployMonitor.DomainUser"> <summary> <para type="description">Adds a domain user to the AD connection.</para> </summary> </member> <member name="P:ControlUp.Automation.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.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.DeployMonitor.InternalDNSName"> <summary> <para type="description">The DNS name of the monitor that needs to be access by all other monitors in the cluster.</para> </summary> </member> <member name="P:ControlUp.Automation.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-monitor-authentication for more details.</para> </summary> </member> <member name="P:ControlUp.Automation.DeployMonitor.CertificatePassword"> <summary> <para type="description">The password that is used to protect the private key of this certificate.</para> </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> |