/ /

/ /

Actualización de la configuración de alertas de Mongocli Ops-Manager

Modifica los detalles de la configuración de alerta especificada para tu proyecto.

Para usar este comando, debes autenticarte con una cuenta de usuario o una clave de API con el rol de Propietario de Proyecto.

Sintaxis

Sintaxis del comando

mongocli ops-manager alerts settings update <alertConfigId> [options]

Arguments

Nombre	Tipo	Requerido	Descripción
alertConfigId	string	true	Identificador único de la configuración de alerta que deseas actualizar.

opciones

Nombre	Tipo	Requerido	Descripción
--apiKey	string	false	Clave API de Datadog, Clave API de Opsgenie o clave API de VictorOps. Obligatorio si notificationType es DATADOG, OPS_GENIE o VICTOR_OPS, respectivamente.
--enabled		false	Bandera que indica si se debe habilitar la configuración de alerta.
--event	string	false	Tipo de evento que activó la alerta. Para aprender qué valores acepta la CLI, consulta los posibles valores de eventTypeName en la documentación de la API para Atlas (https://dochub.mongodb.org/core/atlas-event-names), Ops Manager (https://dochub.mongodb.org/core/om-event-names), o Cloud Manager (https://dochub.mongodb.org/core/cm-event-names).
-h, --help		false	ayuda para actualizar
--matcherFieldName	string	false	Nombre del campo en el objeto de destino para coincidir. Para aprender los valores válidos, ejecuta mongocli Atlas alertas configuración campos tipo.
--matcherOperator	string	false	Operador de comparación que se aplica al comparar la métrica actual con matcherValue. Los valores válidos son CONTAINS, ENDS_WITH, EQUALS, NOT_CONTAINS, NOT_EQUALS, REGEX y STARTS_WITH.
--matcherValue	string	false	Valor para probar con el operador especificado. Si matcherFieldName se establece como TYPE_NAME, puedes hacer coincidir los siguientes valores: CONFIG, MONGOS, primario, secundario, autónomo.
--metricMode	string	false	Opción que indica si Atlas calcula el valor actual de la métrica como un promedio. El valor válido es AVERAGE.
--metricName	string	false	Nombre de la métrica contra la cual este comando verifica la alerta configurada. Para aprender los valores válidos, consulta https://dochub.mongodb.org/core/alert-host-metrics-atlas. Esta opción solo se aplica si el evento está configurado en OUTSIDE_METRIC_THRESHOLD.
--metricOperator	string	false	Operador de comparación a aplicar al verificar el valor actual del métrico. Los valores válidos son LESS_THAN y GREATER_THAN.
--metricThreshold	float	false	Valor de umbral fuera del cual se activará una alerta.
--metricUnits	string	false	Unidades para el valor umbral. Los valores válidos son BITS, BYTES, DÍAS, GIGABITS, GIGABYTES, HORAS, KILOBITS, KILOBYTES, MEGABITS, MEGABYTES, MILISEGUNDOS, MINUTOS, PETABYTES, RAW, SEGUNDOS, TERABYTES.
--notificationChannelName	string	false	Nombre del canal de Slack. Es requerido para el tipo de notificaciones SLACK.
--notificationDelayMin	Int	false	Número de minutos de espera tras detectarse una condición de alerta antes de enviar la primera notificación.
--notificationEmailAddress	string	false	Dirección de correo electrónico a la que se envían las notificaciones de alerta.
--notificationEmailEnabled		false	Bandera que habilita las notificaciones por correo electrónico. Configurable para los tipos de notificación GROUP y USER.
--notificationIntervalMin	Int	false	Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.
--notificationMobileNumber	string	false	Número móvil al que se envían las notificaciones de alerta.
--notificationRegion	string	false	Región que indica qué URL de API se debe usar.
--notificationServiceKey	string	false	Clave de servicio de PagerDuty.
--notificationSmsEnabled		false	Indicador que habilita las notificaciones por mensaje de texto.
--notificationTeamId	string	false	Identificador único de un equipo.
--notificationToken	string	false	Slack API token, or Bot token.
--notificationType	string	false	Tipo de notificación de alerta. Los valores válidos son DATADOG, EMAIL, GROUP (Proyecto), ORG, OPS_GENIE, PAGER_DUTY, SLACK, SMS, USER o VICTOR_OPS.
--notificationUsername	string	false	Nombre del usuario de Atlas al que enviar notificaciones.
--notificationVictorOpsRoutingKey	string	false	Clave de enrutamiento asociada a tu cuenta de Splunk On-Call.
-o, --output	string	false	Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json.
--projectId	string	false	string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno.

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file.

Salida

Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.

Alert configuration '<ID>' updated.

Ejemplos

# Modify the alert configuration with the ID 5d1113b25a115342acc2d1aa so that it notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
mongocli atlas alerts settings update 5d1113b25a115342acc2d1aa --event JOINED_GROUP --enabled \
             --notificationType USER --notificationEmailEnabled \
             --notificationUsername john@example.com \
             --output json --projectId 5df90590f10fab5e33de2305

Volver

Lista

desconocer