Common Services commands

Last Updated : Apr 07, 2021 |

Command

Description

ccm release common-services update-config istio-ingressgateway <a.b.c.d> 

Changes the cluster ingress IP address, where a.b.c.d is the new IPv4 address. The cluster ingress IP address is the cluster IP assigned as the kube-keepalived-vip when the solution is deployed.

ccm release common-services update-config cluster_fqdn <new fqdn> 

Changes the cluster FQDN. If you change the cluster ingress IP address, you must update the cluster FQDN or DNS entry to reflect the new ingress IP address.

ccm release common-services exportPrometheusSnapshot

Backs up solution metric (Prometheus) data.

ccm release common-services alarmctl -l destinations

  • -l destinations: Lists all available destinations.

  • -a destinations [destination-options]: Creates a new alarm destination.

    The following are the available destination options:

    • --address: The IP address of the configured NMS destination.

    • --type: Either TRAP or KAFKA.

    • --port: The listening port of the configured NMS or KAFKA.

    • --username: The user name of the SNMPV3 user configured for the NMS.

    • --password: The password of the SNMPv3 user configured for the NMS.

    • --auth: The authentication protocol for the NMS. Either SHA or MD5.

    • --priv: The privacy protocol configured for the NMS. Either AES or DES.

    • --url: The KAFKA topic name.

    • --authPwd: The authentication password (optional).

    • --privPwd: The privcat password (optional).

  • -d destinations --address <ip-address>: To delete a destination that matches the provided IP address.

  • -l alarmEvents [list-alarm-options]: Lists the alarms on the cluster.

    The available list-alarm option is --alarmId <number>. This is an optional parameter.

  • --state <state> (optional): Indicates the state of the alarm. The state can be ACTIVE or CLEARED.

  • --notificationOid <oid>(optional): Lists the alarm ID associated with the specified OID.

  • --ClearAlarm [clear-alram-options]: Clears the given raised alarm.

    clear-alarm options:

    •  --eventId: The eventId for the alarm being cleared.

    •  --productName: The product name for the alarm being cleared.

    • --productVersion: The product version for the alarm being cleared.

    • --serviceName: The service name for the alarm being cleared.

ccm release common-services alarmctl -a destinations --address <ip-address> --type <TRAP|KAFKA> --port <port-num> [--username <string>] [--password <string>] [--auth <SHA>] [--priv <AES>]  [--authPwd <string>] [--privPwd <string>] [--url <url-string>]

ccm release common-services alarmctl -d destinations --address <ip-address>

ccm release common-services alarmctl -l alarmEvents [--alarmId <number>] [--state <state>] [--notificationOid <oid>]

ccm release common-services alarmctl --ClearAlarm --eventId <number> --productName <CSP> --productVersion <version> --serviceName <service-name>