.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.network_devices_interfaces_query_v2 module -- Resource module for Network Devices Interfaces Query V2 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.1.4). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.network_devices_interfaces_query_v2`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 6.14.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Network Devices Interfaces Query V2. - This API returns the Interface Stats for the given Device Id. Please refer to the Feature tab for the Request Body usage and the API filtering support. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 2.3.7.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_api_port: .. rst-class:: ansible-option-title **_api_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_debug: .. rst-class:: ansible-option-title **_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco CATALYST Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_host: .. rst-class:: ansible-option-title **_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_password: .. rst-class:: ansible-option-title **_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_username: .. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-user: .. rst-class:: ansible-option-title **_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_verify: .. rst-class:: ansible-option-title **_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-_version: .. rst-class:: ansible-option-title **_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco CATALYST Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-deviceid: .. rst-class:: ansible-option-title **deviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
DeviceId path parameter. Network Device Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
UTC epoch timestamp in milliseconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query: .. rst-class:: ansible-option-title **query** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Interfaces Query's query. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/fields: .. rst-class:: ansible-option-title **fields** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Required field names, default ALL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Network Devices Interfaces Query's filters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/filters/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the field that the filter should be applied to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/filters/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Supported operators are eq,in,like. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value of the field. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/page: .. rst-class:: ansible-option-title **page** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Devices Interfaces Query's page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/page/limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of records, Max is 1000. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/page/offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Record offset value, default 0. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/page/orderby: .. rst-class:: ansible-option-title **orderBy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Network Devices Interfaces Query's orderBy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/page/orderby/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the field used to sort. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-query/page/orderby/order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Possible values asc, des. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
UTC epoch timestamp in milliseconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are devices.Devices.get\_device\_interface\_stats\_info\_v2, - Paths used are post /dna/intent/api/v2/networkDevices/{deviceId}/interfaces/query, - Does not support \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Devices GetDeviceInterfaceStatsInfoV2 `_ Complete reference of the GetDeviceInterfaceStatsInfoV2 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.catalystcenter.network_devices_interfaces_query_v2: _host: "{{ _host }}" _username: "{{ _username }}" _password: "{{ _password }}" _verify: "{{ _verify }}" _api_port: "{{ _api_port }}" _version: "{{ _version }}" _debug: "{{ _debug }}" deviceId: string endTime: 0 query: fields: - {} filters: - key: string operator: string value: string page: limit: 0 offset: 0 orderBy: - name: string order: string startTime: 0 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.network_devices_interfaces_query_v2_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"page": {"count": 0, "limit": 0, "offset": 0}, "response": [{"id": "string", "values": {"adminStatus": "string", "description": "string", "deviceId": "string", "duplexConfig": "string", "duplexOper": "string", "instanceId": "string", "interfaceId": "string", "interfaceType": "string", "ipv4Address": "string", "ipv6AddressList": ["string"], "isL3Interface": "string", "isWan": "string", "macAddr": "string", "mediaType": "string", "name": "string", "operStatus": "string", "peerStackMember": "string", "peerStackPort": "string", "portChannelId": "string", "portMode": "string", "portType": "string", "rxDiscards": "string", "rxError": "string", "rxRate": "string", "rxUtilization": "string", "speed": "string", "stackPortType": "string", "timestamp": "string", "txDiscards": "string", "txError": "string", "txRate": "string", "txUtilization": "string", "vlanId": "string"}}], "totalCount": 0, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors