CiscoACI

Docs > Integrations > CiscoACI

Supported OS Linux Mac OS Windows

Integration version2.7.0

Overview

The Cisco ACI Integration lets you:

Track the state and health of your network
Track the capacity of your ACI
Monitor the switches and controllers themselves

Setup

Installation

The Cisco ACI check is packaged with the Agent, so simply install the Agent on a server within your network.

Configuration

Host

To configure this check for an Agent running on a host:

Edit the cisco_aci.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample cisco_aci.d/conf.yaml for all available configuration options:

init_config:

instances:
     ## @param aci_url - string - required
     ## URL to query to gather metrics.
     #
   - aci_url: http://localhost

     ## @param username - string - required
     ## Authentication can use either a user auth or a certificate.
     ## If using the user auth, enter the `username` and `pwd` configuration.
     #
     username: datadog

     ## @param pwd - string - required
     ## Authentication can use either a user auth or a certificate.
     ## If using the user auth, enter the `username` and `pwd` configuration.
     #
     pwd: <PWD>

     ## @param tenant - list of strings - optional
     ## List of tenants to collect metrics data from.
     #
     # tenant:
     #   - <TENANT_1>
     #   - <TENANT_2>

NOTE: Be sure to specify any tenants for the integration to collect metrics on applications, EPG, etc.

Restart the Agent to begin sending Cisco ACI metrics to Datadog.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Parameter	Value
`<INTEGRATION_NAME>`	`cisco_aci`
`<INIT_CONFIG>`	blank or `{}`
`<INSTANCE_CONFIG>`	`{"aci_url":"%%host%%", "username":"<USERNAME>", "pwd": "<PASSWORD>"}`

Validation

Run the Agent’s status subcommand and look for cisco_aci under the Checks section.

Data Collected

Metrics

cisco_aci.capacity.apic.azure_domain.endpoint_group.limit (gauge)	the limit on the number of azure domain endpoint groups the apic can use Shown as item
cisco_aci.capacity.apic.azure_domain.limit (gauge)	the limit on the number of azure domains the apic can use Shown as item
cisco_aci.capacity.apic.bridge_domain.limit (gauge)	the limit on the number of bridge domains the apic can use Shown as item
cisco_aci.capacity.apic.bridge_domain.utilized (gauge)	the bridge domains the apic is utilizing Shown as item
cisco_aci.capacity.apic.contract.limit (gauge)	the limit on the number of contracts the apic can use Shown as item
cisco_aci.capacity.apic.endpoint.limit (gauge)	the limit on the number of endpoints the apic can use Shown as item
cisco_aci.capacity.apic.endpoint.utilized (gauge)	the endpoints the apic is utilizing Shown as item
cisco_aci.capacity.apic.endpoint_group.limit (gauge)	the limit on the number of endpoint groups the apic can use Shown as item
cisco_aci.capacity.apic.endpoint_group.utilized (gauge)	the endpoint groups the apic is utilizing Shown as item
cisco_aci.capacity.apic.fabric_node.limit (gauge)	the limit on the number of fabric nodes the apic can use Shown as item
cisco_aci.capacity.apic.fabric_node.utilized (gauge)	the number of fabric nodes the apic is using Shown as item
cisco_aci.capacity.apic.private_network.limit (gauge)	the limit on the number of fabric nodes the apic can use Shown as item
cisco_aci.capacity.apic.private_network.utilized (gauge)	the number of private networks the apic is using Shown as item
cisco_aci.capacity.apic.service_graph.limit (gauge)	the limit on the number of service graphs the apic can use Shown as item
cisco_aci.capacity.apic.tenant.limit (gauge)	the limit on the number of tenants the apic can use Shown as item
cisco_aci.capacity.apic.tenant.utilized (gauge)	the number of tenants the apic is using Shown as item
cisco_aci.capacity.apic.vmware_domain.endpoint_group.limit (gauge)	the limit on the number of azure domain endpoint groups the apic can use Shown as item
cisco_aci.capacity.apic.vmware_domain.limit (gauge)	the limit on number of vmware domains the apic can use Shown as item
cisco_aci.capacity.leaf.bridge_domain.limit (gauge)	the limit on the number of bridge domains the leaf can use Shown as item
cisco_aci.capacity.leaf.bridge_domain.utilized (gauge)	the number of bridge domains the leaf is using Shown as item
cisco_aci.capacity.leaf.endpoint_group.limit (gauge)	the limit on number of endpoint groups the leaf can use Shown as item
cisco_aci.capacity.leaf.endpoint_group.utilized (gauge)	the number of endpoint groups the leaf is using Shown as item
cisco_aci.capacity.leaf.ipv4_endpoint.limit (gauge)	the limit on the number of ipv4 addresses for the leaf. Requires version 3.1+ Shown as item
cisco_aci.capacity.leaf.ipv4_endpoint.utilized (gauge)	the number of ipv4 addresses the leaf is utilizing. Requires version 3.1+ Shown as item
cisco_aci.capacity.leaf.ipv6_endpoint.limit (gauge)	the limit on the number of ipv6 addresses for the leaf. Requires version 3.1+ Shown as item
cisco_aci.capacity.leaf.ipv6_endpoint.utilized (gauge)	the number of ipv6 addresses the leaf is utilizing. Requires version 3.1+ Shown as item
cisco_aci.capacity.leaf.multicast.limit (gauge)	the multicast endpoint capacity of the leaf Shown as item
cisco_aci.capacity.leaf.multicast.utilized (gauge)	the multicast endpoint capacity utilized by the leaf Shown as item
cisco_aci.capacity.leaf.policy_cam.limit (gauge)	the limit on the number of policies in the policy cam Shown as item
cisco_aci.capacity.leaf.policy_cam.utilized (gauge)	the number of policies the policy cam is utilizing Shown as item
cisco_aci.capacity.leaf.vlan.limit (gauge)	the limit on the number of vlans for the leaf Shown as item
cisco_aci.capacity.leaf.vlan.utilized (gauge)	the number of vlan the leaf is utilizing Shown as item
cisco_aci.capacity.leaf.vrf.limit (gauge)	the limit on the number of vrfs the leaf can use Shown as item
cisco_aci.capacity.leaf.vrf.utilized (gauge)	the number of vrfs the leaf is using Shown as item
cisco_aci.fabric.node.cpu.avg (gauge)	average cpu usage of the node Shown as percent
cisco_aci.fabric.node.cpu.idle.avg (gauge)	average idle cpu of the node Shown as percent
cisco_aci.fabric.node.cpu.idle.max (gauge)	max idle cpu of the node Shown as percent
cisco_aci.fabric.node.cpu.idle.min (gauge)	minimum idle cpu of the node Shown as percent
cisco_aci.fabric.node.cpu.max (gauge)	max cpu usage of the node Shown as percent
cisco_aci.fabric.node.cpu.min (gauge)	minimum cpu usage of the node Shown as percent
cisco_aci.fabric.node.egr_bytes.flood (gauge)	Egress flood packets Shown as byte
cisco_aci.fabric.node.egr_bytes.flood.cum (gauge)	the cumulative flood packets sent from the node Shown as byte
cisco_aci.fabric.node.egr_bytes.multicast (gauge)	the number of multicast bytes coming from the node Shown as byte
cisco_aci.fabric.node.egr_bytes.multicast.cum (gauge)	the cumulative multicast bytes sent from the node Shown as byte
cisco_aci.fabric.node.egr_bytes.unicast (gauge)	the number of unicast bytes coming from the node Shown as byte
cisco_aci.fabric.node.egr_bytes.unicast.cum (gauge)	the cumulative bytes sent from the node Shown as byte
cisco_aci.fabric.node.egr_drop_pkts.buffer (gauge)	the packets dropped because the buffer is full Shown as packet
cisco_aci.fabric.node.egr_drop_pkts.buffer.cum (gauge)	the cumulative packets dropped because the buffer is full Shown as packet
cisco_aci.fabric.node.egr_drop_pkts.errors (gauge)	the packets dropped because of errors Shown as packet
cisco_aci.fabric.node.egr_total.bytes.cum (gauge)	the cumulative bytes sent from the node Shown as byte
cisco_aci.fabric.node.egr_total.bytes.rate (gauge)	the bytes per second sent from the node Shown as byte
cisco_aci.fabric.node.egr_total.pkts (gauge)	the packets sent from the node Shown as packet
cisco_aci.fabric.node.egr_total.pkts.rate (gauge)	the packets per second sent from the node Shown as packet
cisco_aci.fabric.node.fault_counter.crit (gauge)	the number of critical faults on the node Shown as fault
cisco_aci.fabric.node.fault_counter.warn (gauge)	the number of warnings on the node Shown as fault
cisco_aci.fabric.node.health.cur (gauge)	the current health of the node
cisco_aci.fabric.node.health.max (gauge)	The max health of the node
cisco_aci.fabric.node.health.min (gauge)	the minimum health of the node
cisco_aci.fabric.node.ingr_bytes.flood (gauge)	Ingress flood packets Shown as byte
cisco_aci.fabric.node.ingr_bytes.flood.cum (gauge)	the cumulative flood packets sent to the node Shown as byte
cisco_aci.fabric.node.ingr_bytes.multicast (gauge)	the number of multicast bytes coming into the node Shown as byte
cisco_aci.fabric.node.ingr_bytes.multicast.cum (gauge)	the cumulative multicast bytes sent to the node Shown as byte
cisco_aci.fabric.node.ingr_bytes.unicast (gauge)	the number of unicast bytes coming into the node Shown as byte
cisco_aci.fabric.node.ingr_bytes.unicast.cum (gauge)	the cumulative bytes sent to the node Shown as byte
cisco_aci.fabric.node.ingr_total.bytes.cum (gauge)	the cumulative bytes sent to the node Shown as byte
cisco_aci.fabric.node.ingr_total.bytes.rate (gauge)	the bytes per second sent to the node Shown as packet
cisco_aci.fabric.node.ingr_total.pkts (gauge)	the packets sent to the node Shown as packet
cisco_aci.fabric.node.ingr_total.pkts.rate (gauge)	the packets per second sent to the node Shown as packet
cisco_aci.fabric.node.mem.avg (gauge)	average memory usage of the node Shown as byte
cisco_aci.fabric.node.mem.free.avg (gauge)	average free memory of the node Shown as byte
cisco_aci.fabric.node.mem.free.max (gauge)	max free memory of the node Shown as byte
cisco_aci.fabric.node.mem.free.min (gauge)	minimum free memory of the node Shown as byte
cisco_aci.fabric.node.mem.max (gauge)	max memory usage of the node Shown as byte
cisco_aci.fabric.node.mem.min (gauge)	minimum memory usage of the node Shown as byte
cisco_aci.fabric.pod.egr_bytes.flood (gauge)	Egress flood packets Shown as byte
cisco_aci.fabric.pod.egr_bytes.flood.cum (gauge)	the cumulative flood packets sent from the pod Shown as byte
cisco_aci.fabric.pod.egr_bytes.multicast (gauge)	the number of multicast bytes coming from the pod Shown as byte
cisco_aci.fabric.pod.egr_bytes.multicast.cum (gauge)	the cumulative multicast bytes sent from the pod Shown as byte
cisco_aci.fabric.pod.egr_bytes.unicast (gauge)	the number of unicast bytes coming from the pod Shown as byte
cisco_aci.fabric.pod.egr_bytes.unicast.cum (gauge)	the cumulative bytes sent from the pod Shown as byte
cisco_aci.fabric.pod.egr_drop_pkts.buffer (gauge)	the packets dropped because the buffer is full Shown as packet
cisco_aci.fabric.pod.egr_drop_pkts.buffer.cum (gauge)	the cumulative packets dropped because the buffer is full Shown as packet
cisco_aci.fabric.pod.egr_drop_pkts.errors (gauge)	the packets dropped because of errors Shown as packet
cisco_aci.fabric.pod.egr_total.bytes.cum (gauge)	the cumulative bytes sent from the pod Shown as byte
cisco_aci.fabric.pod.egr_total.bytes.rate (gauge)	the bytes per second sent from the pod Shown as byte
cisco_aci.fabric.pod.egr_total.pkts (gauge)	the packets sent from the pod Shown as packet
cisco_aci.fabric.pod.egr_total.pkts.rate (gauge)	the packets per second sent from the pod Shown as packet
cisco_aci.fabric.pod.fault_counter.crit (gauge)	the number of critical faults on the pod Shown as fault
cisco_aci.fabric.pod.fault_counter.warn (gauge)	the number of warnings on the pod Shown as fault
cisco_aci.fabric.pod.health.cur (gauge)	the current health of the pod
cisco_aci.fabric.pod.health.max (gauge)	the maximum health of the pod
cisco_aci.fabric.pod.health.min (gauge)	the minimum health of the pod
cisco_aci.fabric.pod.ingr_bytes.flood (gauge)	Ingress flood packets Shown as byte
cisco_aci.fabric.pod.ingr_bytes.flood.cum (gauge)	the cumulative flood packets sent to the pod Shown as byte
cisco_aci.fabric.pod.ingr_bytes.multicast (gauge)	the number of multicast bytes coming into the pod Shown as byte
cisco_aci.fabric.pod.ingr_bytes.multicast.cum (gauge)	the cumulative multicast bytes sent to the pod Shown as byte
cisco_aci.fabric.pod.ingr_bytes.unicast (gauge)	the number of unicast bytes coming into the pod Shown as byte
cisco_aci.fabric.pod.ingr_bytes.unicast.cum (gauge)	the cumulative bytes sent to the pod Shown as byte
cisco_aci.fabric.pod.ingr_total.bytes.cum (gauge)	the cumulative bytes sent to the pod Shown as byte
cisco_aci.fabric.pod.ingr_total.bytes.rate (gauge)	the bytes per second sent to the pod Shown as packet
cisco_aci.fabric.pod.ingr_total.pkts (gauge)	the packets sent to the pod Shown as packet
cisco_aci.fabric.pod.ingr_total.pkts.rate (gauge)	the packets per second sent to the pod Shown as packet
cisco_aci.fabric.port.egr_bytes.flood (gauge)	Egress flood packets Shown as byte
cisco_aci.fabric.port.egr_bytes.flood.cum (gauge)	the cumulative flood packets sent from the port Shown as byte
cisco_aci.fabric.port.egr_bytes.multicast (gauge)	the number of multicast bytes coming from the port Shown as byte
cisco_aci.fabric.port.egr_bytes.multicast.cum (gauge)	the cumulative multicast bytes sent from the port Shown as byte
cisco_aci.fabric.port.egr_bytes.unicast (gauge)	the number of unicast bytes coming from the port Shown as byte
cisco_aci.fabric.port.egr_bytes.unicast.cum (gauge)	the cumulative bytes sent from the port Shown as byte
cisco_aci.fabric.port.egr_drop_pkts.buffer (gauge)	the packets dropped because the buffer is full Shown as packet
cisco_aci.fabric.port.egr_drop_pkts.buffer.cum (gauge)	the cumulative packets dropped because the buffer is full Shown as packet
cisco_aci.fabric.port.egr_drop_pkts.errors (gauge)	the packets dropped because of errors Shown as packet
cisco_aci.fabric.port.egr_total.bytes.cum (gauge)	the cumulative bytes sent from the port Shown as byte
cisco_aci.fabric.port.egr_total.bytes.rate (gauge)	the bytes per second sent from the port Shown as byte
cisco_aci.fabric.port.egr_total.pkts (gauge)	the packets sent from the port Shown as packet
cisco_aci.fabric.port.egr_total.pkts.rate (gauge)	the packets per second sent from the port Shown as packet
cisco_aci.fabric.port.fault_counter.crit (gauge)	the number of critical faults on the port Shown as fault
cisco_aci.fabric.port.fault_counter.warn (gauge)	the number of warnings on the port Shown as fault
cisco_aci.fabric.port.ingr_bytes.flood (gauge)	Ingress flood packets Shown as byte
cisco_aci.fabric.port.ingr_bytes.flood.cum (gauge)	the cumulative flood packets sent to the port Shown as byte
cisco_aci.fabric.port.ingr_bytes.multicast (gauge)	the number of multicast bytes coming into the port Shown as byte
cisco_aci.fabric.port.ingr_bytes.multicast.cum (gauge)	the cumulative multicast bytes sent to the port Shown as byte
cisco_aci.fabric.port.ingr_bytes.unicast (gauge)	the number of unicast bytes coming into the port Shown as byte
cisco_aci.fabric.port.ingr_bytes.unicast.cum (gauge)	the cumulative bytes sent to the port Shown as byte
cisco_aci.fabric.port.ingr_total.bytes.cum (gauge)	the cumulative bytes sent to the port Shown as byte
cisco_aci.fabric.port.ingr_total.bytes.rate (gauge)	the bytes per second sent to the port Shown as packet
cisco_aci.fabric.port.ingr_total.pkts (gauge)	the packets sent to the port Shown as packet
cisco_aci.fabric.port.ingr_total.pkts.rate (gauge)	the packets per second sent to the port Shown as packet
cisco_aci.tenant.application.endpoint.fault_counter (gauge)	represents the warning Fault. This is the average value read by the counter during the collection interval. Note that this value resets to 0 at the beginning of each interval Shown as fault
cisco_aci.tenant.application.endpoint.health (gauge)	represents the most current statistics for the endpoint health Shown as percent
cisco_aci.tenant.application.endpoint.overall_health (gauge)	represents the statistics for the overall endpoint health Shown as percent
cisco_aci.tenant.application.fault_counter (gauge)	represents the warning Fault. This is the average value read by the counter during the collection interval. Note that this value resets to 0 at the beginning of each interval Shown as fault
cisco_aci.tenant.application.health (gauge)	represents the most current statistics for the application health Shown as percent
cisco_aci.tenant.application.overall_health (gauge)	represents the statistics for the overall application health Shown as percent
cisco_aci.tenant.egress_bytes.drop.cum (gauge)	represents the Egress drop bytes. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.egress_bytes.flood.cum (gauge)	represents the Egress flood bytes. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.egress_bytes.multicast.cum (gauge)	represents the sum total of values read by the multicast counter. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.egress_bytes.multicast.rate (gauge)	represents the rate of the egress multicast counter readings in an interval. The rate is calculated by dividing the periodic value by the length of the interval. This value resets to 0 at the beginning of each interval Shown as byte
cisco_aci.tenant.egress_bytes.unicast.cum (gauge)	represents the sum total of values read by the unicast counter. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.egress_bytes.unicast.rate (gauge)	represents the rate of the egress unicast counter readings in an interval. The rate is calculated by dividing the periodic value by the length of the interval. This value resets to 0 at the beginning of each interval Shown as byte
cisco_aci.tenant.egress_pkts.drop.cum (gauge)	represents the Egress drop packets. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.egress_pkts.flood.cum (gauge)	represents the Egress flood packets. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.egress_pkts.multicast.cum (gauge)	represents the sum total of values read by the multicast counter. Note that this value continues through each interval without resetting to zero. Shown as packet
cisco_aci.tenant.egress_pkts.multicast.rate (gauge)	represents the rate of the ingress multicast counter readings in an interval. The rate is calculated by dividing the periodic value by the length of the interval. This value resets to 0 at the beginning of each interval Shown as packet
cisco_aci.tenant.egress_pkts.unicast.cum (gauge)	represents the sum total of values read by the unicast counter. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.egress_pkts.unicast.rate (gauge)	represents the rate of the ingress unicast counter readings in an interval. The rate is calculated by dividing the periodic value by the length of the interval. This value resets to 0 at the beginning of each interval Shown as packet
cisco_aci.tenant.fault_counter (gauge)	represents the warning Fault. This is the average value read by the counter during the collection interval. Note that this value resets to 0 at the beginning of each interval Shown as fault
cisco_aci.tenant.health (gauge)	represents the most current statistics for the tenant health Shown as percent
cisco_aci.tenant.ingress_bytes.drop.cum (gauge)	represents the Ingress drop bytes. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.ingress_bytes.flood.cum (gauge)	represents the Ingress flood bytes. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.ingress_bytes.multicast.cum (gauge)	represents the Ingress multicast bytes. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.ingress_bytes.multicast.rate (gauge)	represents the Ingress multicast bytes. This is the rate of the counter during the collection interval. The rate is calculated by dividing the periodic value by the length of the collection interval. Note that this value resets to 0 at the beginning of each interval. Shown as byte
cisco_aci.tenant.ingress_bytes.unicast.cum (gauge)	represents the Ingress unicast bytes. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as byte
cisco_aci.tenant.ingress_bytes.unicast.rate (gauge)	represents the Ingress unicast bytes. This is the rate of the counter during the collection interval. The rate is calculated by dividing the periodic value by the length of the collection interval. Note that this value resets to 0 at the beginning of each interval Shown as byte
cisco_aci.tenant.ingress_pkts.drop.cum (gauge)	represents the Ingress drop packets. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.ingress_pkts.flood.cum (gauge)	represents the Ingress flood packets. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.ingress_pkts.multicast.cum (gauge)	represents the Ingress multicast packets. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.ingress_pkts.multicast.rate (gauge)	represents the Ingress multicast packets. This is the rate of the counter during the collection interval. The rate is calculated by dividing the periodic value by the length of the collection interval. Note that this value resets to 0 at the beginning of each interval Shown as packet
cisco_aci.tenant.ingress_pkts.unicast.cum (gauge)	represents the Ingress unicast packets. The total sum of the values read. Note that this value continues through each interval without resetting to zero Shown as packet
cisco_aci.tenant.ingress_pkts.unicast.rate (gauge)	represents the Ingress unicast packets. This is the rate of the counter during the collection interval. The rate is calculated by dividing the periodic value by the length of the collection interval. Note that this value resets to 0 at the beginning of each interval Shown as packet
cisco_aci.tenant.overall_health (gauge)	represents the statistics for overall tenant health Shown as percent

Events

The Cisco ACI check sends tenant faults as events.

Service Checks

cisco_aci.can_connect
Returns CRITICAL if the Agent check is unable to connect to the monitored cisco_aci instance. Returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Missing `cisco_aci.tenant.*` metrics

If you are missing cisco_aci.tenant.* metrics, you can run the test/cisco_aci_query.py script to manually query the tenant endpoint.

Modify the apic_url, apic_username, and apic_password to your configuration information, and input the tenant URL for the apic_url.

Verify that the output you get from cURLing the endpoint matches any of the metrics collected in datadog_checks/cisco_aci/aci_metrics.py. If none of the statistics match, this means that the endpoint is not emitting any statistics that the integration can collect.

Long execution times

Because this check queries all the tenants, apps, and endpoints listed before returning metrics, there may be high execution times coming from this integration.

  cisco_aci (2.2.0)
-----------------
  Instance ID: cisco_aci:d3a2958f66f46212 [OK]
  Configuration Source: file:/etc/datadog-agent/conf.d/cisco_aci.d/conf.yaml
  Total Runs: 1
  Metric Samples: Last Run: 678, Total: 678
  Events: Last Run: 0, Total: 0
  Service Checks: Last Run: 1, Total: 1
  Average Execution Time : 28m20.95s
  Last Execution Date : 2023-01-04 15:58:04 CST / 2023-01-04 21:58:04 UTC (1672869484000)
  Last Successful Execution Date : 2023-01-04 15:58:04 CST / 2023-01-04 21:58:04 UTC (1672869484000)

Need help? Contact Datadog support.