Aruba Central Poller

The Aruba Central Poller microservice polls devices, topology data, and metric data from HPE Aruba Networking Central.

This microservice supports the discovery and insertion of topology hierarchy as provided by Aruba Networking Central. The hierarchy reflects the structure defined in Aruba Networking Central (for example, customers, sites, gateways, switches, access points, and interfaces). For each vertex in the hierarchy, the microservice also captures and stores any associated metadata.

This microservice is part of the Discovery and Metric microservice pipelines. See Understanding Microservice Pipelines in Unified Assurance Concepts for conceptual information about microservice pipelines.

You can configure redundancy settings for this microservice when you deploy it. See Configuring Microservice Redundancy for general information.

This microservice provides additional Prometheus monitoring metrics. See Aruba Central Poller Self-Monitoring Metrics.

Aruba Central Poller Prerequisites

Before deploying the Aruba Central Poller microservice, confirm that the following prerequisites are met:

  1. A microservice cluster is set up. See Microservice Cluster Setup.

  2. The following microservices are deployed:

Deploying Aruba Central Poller

To deploy the microservice, run the following commands:

su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<webFQDN> 
a1helm install <microservice-release-name> assure1/aruba-central-poller -n $NAMESPACE --set global.imageRegistry=$WEBFQDN

In the commands:

You can also use the Unified Assurance UI to deploy microservices. See Deploying a Microservice by Using the UI for more information.

Changing Aruba Central Poller Configuration Parameters

When running installation command, you can optionally change default configuration parameter values by including them in the command with additional --set arguments. You can add as many additional --set arguments as you need.

For example, set a parameter described in Default Aruba Central Poller Configuration by adding --set configData.<parameter_name>=<parameter_value>. For example, --set configData.LOG_LEVEL=DEBUG.

Default Aruba Central Poller Configuration

The following table describes the default configuration parameters found in the Helm chart under configData for the Aruba Central Poller microservice.

Name Default Value Possible Values Notes
LOG_LEVEL INFO FATAL, ERROR, WARN, INFO, DEBUG The logging level used by the microservice.
STREAM_INPUT "" persistent://assure1/discovery/aruba-central-poller-zoneX The path to the Pulsar topic to get data from. The topic at end of path may be any text value.
STREAM_OUTPUT "" persistent://assure1/discovery/discovery-service-zoneX The path to the Pulsar topic to send data to. The topic at end of path may be any text value.
STREAM_OUTPUT_METRIC persistent://assure1/metric/sink Text, 255 characters The path to the Pulsar topic to send metric data to. The topic at end of path may be any text value.
PROXY_URL "" Text, 255 characters The proxy URL to use.
THROTTLE_DELAY_IN_MS 0 Integer The time to wait, in milliseconds, between API calls.
ENABLE_PCOM_POLLING true Boolean Whether to enable performance polling (true) or disable it (false).
CONFIG_CHECK_INTERVAL_M 5 Integer The interval, in minutes, after which to refresh the device configuration from the database.
WEBHOOK_USE_SSL false Boolean Whether to use http or https during webhook creation. If WEBHOOK_HOST has the protocol, then that is used.
WEBHOOK_HOST "" Text, 255 characters The host to create the webhook on. The cluster host is used if this value is not specified.
WEBHOOK_ENDPOINT /webhook/aruba Text, 255 characters The endpoint to use for webhook.
LOOKUP_FILE_PATH /core/default/processing/event/fcom/_lookups/aruba-zones.json Text, 255 characters The SVN path to the Aruba zone lookup file.
REDUNDANCY_POLL_PERIOD 5 Integer The number of seconds between status checks from the secondary microservice to the primary microservice.
REDUNDANCY_FAILOVER_THRESHOLD 4 Integer The number of times the primary microservice must fail checks before the secondary microservice becomes active.
REDUNDANCY_FALLBACK_THRESHOLD 1 Integer The number of times the primary microservice must succeed checks before the secondary microservice becomes inactive.

Aruba Central Poller Self-Monitoring Metrics

The Aruba Central Poller microservice exposes the self-monitoring metrics described in the following table to Prometheus.

Metric Name Type Description
pcom_targets Gauge The number of PCOM targets being polled.

Note:

Metric names in the database include a prefix that indicates the service that inserted them. The prefix is prom_ for metrics inserted by Prometheus. For example, pcom_targets is stored as prom_pcom_targets in the database.

Aruba Central Poller Webhook URL Construction

The Aruba Central Poller subscribes to events with a webhook subscription. When deploying the microservice, you can use the default webhook options, or you can set them in configure parameters. You can specify whether to use SSL, set the webhook host, and define the webhook endpoint.

When you deploy the microservice without specifying any additional webhook options, you get the following URL from the default settings:

http://<master_host_of_cluster>:9080/webhook-service/webhook/aruba

When you add --set configData.WEBHOOK_USE_SSL=true when deploying the microservice, you get the following URL:

https://<master_host_of_cluster>:9443/webhook-service/webhook/aruba

When you add all webhook configuration parameters, as follows:

a1helm install aruba-central-poller assure1/aruba-central-poller -n $NAMESPACE --set global.imageRegistry=$WEBFQDN --set configData.WEBHOOK_USE_SSL=true --set configData.WEBHOOK_HOST="example.com" --set configData.WEBHOOK_ENDPOINT="/custom/webhook/endpoint"

You get the following URL:

https://example.com/custom/webhook/endpoint