Try SpotterRetrieves Policy CAM Statistics Hit Counts
| "added in version" 0.5.0 of cisco.nd"
Authors: Akini Ross (@akinross)
preview | supported by community
Install with ansible-galaxy collection install cisco.nd:==0.5.0
collections:
- name: cisco.nd
version: 0.5.0Retrieves Policy CAM Statistics Hit Counts on Cisco Nexus Dashboard Insights (NDI).
- name: Get Policy CAM Statistics Hit Counts for epgs, tenants, and leafs
cisco.nd.nd_policy_cam_statistics_hit_counts:
insights_group: igName
site: siteName
epgs: true
tenants: true
leafs: true
register: query_results
- name: Get Policy CAM Statistics Hit Counts for epgs, with a specific epoch_id
cisco.nd.nd_policy_cam_statistics_hit_counts:
insights_group: igName
site: siteName
epoch_id: 0e5604f9-373a123c-b535-33fc-8d11-672d08f65fd1
epgs: true
register: query_results
- name: Get Policy CAM Statistics Hit Counts for contracts, filters, and a attributes filtering
cisco.nd.nd_policy_cam_statistics_hit_counts:
insights_group: igName
site: siteName
contracts: true
filters: true
filter_by_attributes:
- key: providerEpgName
value: log_epg
- key: consumerEpgName
value: app_epg
register: query_results
- name: Get Policy CAM Statistics Hit Counts for epgs, leafs, contracts, filters, and output to csv
cisco.nd.nd_policy_cam_statistics_hit_counts:
insights_group: igName
site: siteName
epgs: true
leafs: true
contracts: true
filters: true
output_csv: hits.csv
register: query_results
epgs:
default: false
description:
- All Policy CAM Rules by Hit Count by EPGs.
type: bool
host:
aliases:
- hostname
description:
- IP Address or hostname of the Nexus Dashboard (ND) host.
- If the value is not specified in the task, the value of environment variable C(ND_HOST)
will be used instead.
type: str
port:
description:
- Port number to be used for the REST connection.
- The default value depends on parameter `use_ssl`.
- If the value is not specified in the task, the value of environment variable C(ND_PORT)
will be used instead.
type: int
site:
aliases:
- site_name
description:
- The name of the site.
required: true
type: str
leafs:
default: false
description:
- All Policy CAM Rules by Hit Count by Leafs.
type: bool
filters:
default: false
description:
- All Policy CAM Rules by Hit Count by Filters.
type: bool
tenants:
default: false
description:
- All Policy CAM Rules by Hit Count by Tenants.
type: bool
timeout:
default: 30
description:
- The socket level timeout in seconds.
- If the value is not specified in the task, the value of environment variable C(ND_TIMEOUT)
will be used instead.
type: int
use_ssl:
description:
- If C(no), an HTTP connection will be used instead of the default HTTPS connection.
- If the value is not specified in the task, the value of environment variable C(ND_USE_SSL)
will be used instead.
type: bool
epoch_id:
description:
- The id of the epoch.
- When epoch id is not provided it will retrieve the latest known epoch id.
- The M(cisco.nd.nd_epoch) can be used to retrieve a specific epoch id.
type: str
password:
description:
- The password to use for authentication.
- If the value is not specified in the task, the value of environment variables C(ND_PASSWORD)
or C(ANSIBLE_NET_PASSWORD) will be used instead.
type: str
username:
description:
- The username to use for authentication.
- If the value is not specified in the task, the value of environment variables C(ND_USERNAME)
or C(ANSIBLE_NET_USERNAME) will be used instead.
type: str
contracts:
default: false
description:
- All Policy CAM Rules by Hit Count by Contracts.
type: bool
use_proxy:
description:
- If C(no), it will not use a proxy, even if one is defined in an environment variable
on the target hosts.
- If the value is not specified in the task, the value of environment variable C(ND_USE_PROXY)
will be used instead.
type: bool
output_csv:
description:
- Path to a file to save the generated csv file.
- When extension is not matching .csv it will be added automatically.
type: str
login_domain:
description:
- The login domain name to use for authentication.
- The default value is DefaultAuth.
- If the value is not specified in the task, the value of environment variable C(ND_LOGIN_DOMAIN)
will be used instead.
type: str
output_level:
choices:
- debug
- info
- normal
default: normal
description:
- Influence the output of this ND module.
- C(normal) means the standard output, incl. C(current) dict
- C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
- C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
C(status) and C(url) information
- If the value is not specified in the task, the value of environment variable C(ND_OUTPUT_LEVEL)
will be used instead.
type: str
insights_group:
aliases:
- fab_name
- ig_name
description:
- The name of the insights group.
required: true
type: str
validate_certs:
description:
- If C(no), SSL certificates will not be validated.
- This should only set to C(no) when used on personally controlled sites using self-signed
certificates.
- If the value is not specified in the task, the value of environment variable C(ND_VALIDATE_CERTS)
will be used instead.
type: bool
filter_by_attributes:
description:
- Container for all filter by attributes pairs.
elements: dict
suboptions:
key:
choices:
- provider_epg
- consumer_epg
- provider_tenant
- consumer_tenant
- contract
- filter
- consumer_vrf
- action
- leaf
description:
- The key of the attribute to match.
required: true
type: str
value:
description:
- The value of the attribute to match.
required: true
type: str
type: list