automation-suite
2024.10
true
- Overview
- Pre-installation
- Installation
- Cluster administration
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl config add-host-admin
- uipathctl config argocd
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl version
- Backup and restore
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- Certificate management
- uipathctl config additional-ca-certificates
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config saml-certificates
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- Upgrade
- Authentication
- Monitoring and alerting
- Product-specific configuration
- Troubleshooting
uipathctl config alerts add-email
uipathctl Reference Guide
Last updated Nov 11, 2024
uipathctl config alerts add-email
Add email receiver for Alertmanager.
uipathctl config alerts add-email [flags]
uipathctl config alerts add-email [flags]
# Adds new email receiver based on parameters passed in command
uipathctl config alerts add-email --name test --to "admin@example.com" --from "admin@example.com" --smtp "server.mycompany.com:443" --username admin --password "somepassword" --require-tls --ca-file "file path too rootCA" --cert-file "file path too server certificate" --key-file "file path too server key file"
# Adds new email receiver based on parameters passed in command
uipathctl config alerts add-email --name test --to "admin@example.com" --from "admin@example.com" --smtp "server.mycompany.com:443" --username admin --password "somepassword" --require-tls --ca-file "file path too rootCA" --cert-file "file path too server certificate" --key-file "file path too server key file"
--ASEA Boolean flag to denote whether the cluster is ASEA or not
--ca-file string File path containing the CA certificate of the SMTP server. This parameter is optional if the CA is private
--cert-file string File path containing the certificate of the SMTP server. This parameter is optional if the certificate is private
--from string The sender's email address
-h, --help help for add-email
--key-file string File path containing the private key of the certificate for the SMTP server. This parameter is required if the certificate is private
--name string Name of the email configuration
--password string SMTP authentication Password
--require-tls Boolean flag to denote that TLS is enabled at the SMTP server (default true)
--send-resolved Boolean flag to denote whether to send email on resolved alert (default true)
--smtp string SMTP server URL or IP, including port
--to string Receiver's email address
--username string SMTP authentication Username
--ASEA Boolean flag to denote whether the cluster is ASEA or not
--ca-file string File path containing the CA certificate of the SMTP server. This parameter is optional if the CA is private
--cert-file string File path containing the certificate of the SMTP server. This parameter is optional if the certificate is private
--from string The sender's email address
-h, --help help for add-email
--key-file string File path containing the private key of the certificate for the SMTP server. This parameter is required if the certificate is private
--name string Name of the email configuration
--password string SMTP authentication Password
--require-tls Boolean flag to denote that TLS is enabled at the SMTP server (default true)
--send-resolved Boolean flag to denote whether to send email on resolved alert (default true)
--smtp string SMTP server URL or IP, including port
--to string Receiver's email address
--username string SMTP authentication Username
--context string name of the kubeconfig context to use
--kubeconfig string kubectl configuration file (default: ~/.kube/config)
--log-format string log format. one of [text,json] (default "text")
--log-level string set log level. one of [trace,debug,info,error] (default "error")
-q, --quiet suppress all output except for errors and warnings
--timeout duration timeout of the command (default 1h0m0s)
--context string name of the kubeconfig context to use
--kubeconfig string kubectl configuration file (default: ~/.kube/config)
--log-format string log format. one of [text,json] (default "text")
--log-level string set log level. one of [trace,debug,info,error] (default "error")
-q, --quiet suppress all output except for errors and warnings
--timeout duration timeout of the command (default 1h0m0s)