cisco.catalystcenter.interfaces_query module -- Resource module for Interfaces Query
Note
This module is part of the cisco.catalystcenter collection (version 2.11.0).
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.interfaces_query.
New in cisco.catalystcenter 1.0.0
Synopsis
Manage operation create of the resource Interfaces Query.
Gets the list of interfaces across the Network Devices based on the provided.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.2.3.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Interfaces Query's aggregateAttributes. |
|
Interfaces Query's function. |
|
Interfaces Query's name. |
|
Interfaces Query's attributes. |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Interfaces Query's endTime. |
|
Interfaces Query's filters. |
|
Interfaces Query's filters. |
|
Interfaces Query's filters. |
|
Interfaces Query's key. |
|
Interfaces Query's logicalOperator. |
|
Interfaces Query's operator. |
|
Interfaces Query's value. |
|
Interfaces Query's key. |
|
Interfaces Query's logicalOperator. |
|
Interfaces Query's operator. |
|
Interfaces Query's value. |
|
Interfaces Query's page. |
|
Interfaces Query's limit. |
|
Interfaces Query's offset. |
|
Interfaces Query's sortBy. |
|
Interfaces Query's name. |
|
Interfaces Query's order. |
|
Interfaces Query's startTime. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
Interfaces Query's views. |
Notes
Note
SDK Method used are devices.Devices.gets_the_list_of_interfaces_across_the_network_devices_based_on_the_provided_complex_filters_and_aggregation_functions,
Paths used are post /dna/data/api/v1/interfaces/query,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)
See Also
See also
- Cisco Catalyst Center documentation for Devices GetsTheListOfInterfacesAcrossTheNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctions
Complete reference of the GetsTheListOfInterfacesAcrossTheNetworkDevicesBasedOnTheProvidedComplexFiltersAndAggregationFunctions API.
Examples
---
- name: Create
cisco.catalystcenter.interfaces_query:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_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: {}
page:
limit: 0
offset: 0
sortBy:
- name: string
order: string
startTime: 0
views:
- string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|