cisco.catalystcenter.dhcp_services_summary_analytics module -- Resource module for Dhcp Services Summary Analytics

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.dhcp_services_summary_analytics.

New in cisco.catalystcenter 6.17.0

Synopsis

• This module represents an alias of the module dhcp_services_summary_analytics_v1

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
aggregateAttributes list / elements=dictionary	Dhcp Services Summary Analytics's aggregateAttributes.
function string	Function.
name string	Name.
attributes list / elements=string	Attributes.
endTime integer	End Time.
filters list / elements=dictionary	Dhcp Services Summary Analytics's filters.
filters list / elements=dictionary	Dhcp Services Summary Analytics's filters.
filters list / elements=string	Filters.
key string	Key.
logicalOperator string	Logical Operator.
operator string	Operator.
value dictionary	Value.
key string	Key.
logicalOperator string	Logical Operator.
operator string	Operator.
value dictionary	Value.
groupBy list / elements=string	Group By.
headers dictionary	Additional headers.
page dictionary	Dhcp Services Summary Analytics's page.
limit integer	Limit.
offset integer	Offset.
sortBy list / elements=dictionary	Dhcp Services Summary Analytics's sortBy.
function string	Function.
name string	Name.
order string	Order.
startTime integer	Start Time.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are devices.Devices.get_summary_analytics_data_of_d_h_c_p_services_for_given_set_of_complex_filters_v1,

• Paths used are post /dna/data/api/v1/dhcpServices/summaryAnalytics,

• It should be noted that this module is an alias of dhcp_services_summary_analytics_v1

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Devices GetSummaryAnalyticsDataOfDHCPServicesForGivenSetOfComplexFiltersV1

Complete reference of the GetSummaryAnalyticsDataOfDHCPServicesForGivenSetOfComplexFiltersV1 API.

Examples

- name: Create
  cisco.catalystcenter.dhcp_services_summary_analytics:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    aggregateAttributes:
      - function: string
        name: string
    attributes:
      - string
    endTime: 0
    filters:
      - filters:
          - filters:
              - string
            key: string
            logicalOperator: string
            operator: string
            value: {}
        key: string
        logicalOperator: string
        operator: string
        value: {}
    groupBy:
      - string
    headers: '{{my_headers | from_json}}'
    page:
      limit: 0
      offset: 0
      sortBy:
        - function: string
          name: string
          order: string
    startTime: 0

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

catalystcenter_response dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"page": {"count": "string", "limit": 0, "offset": 0, "sortBy": [{"function": "string", "name": "string", "order": "string"}]}, "response": {"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": "string"}], "groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": "string"}], "id": "string"}]}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)