cisco.catalystcenter.tracked_clients_query_create module -- Resource module for Tracked Clients Query Create

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.tracked_clients_query_create.

New in cisco.catalystcenter 2.11.0

Synopsis 

Manage operation create of the resource Tracked Clients Query Create.
Returns tracked-client configurations matching the provided request-body filters.

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
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
filters list / elements=dictionary	List of filters to apply when querying tracked-client configurations. Supported operators by field are `clientMacAddress`, `duid`, `description` eq, neq, in, notIn, like, liker `trackingStartTime`, `trackingEndTime` eq, neq, lt, gt, lte, gte `isPresentOnNetwork` eq, neq `randomizedMacAddresses` eq, neq, in, notIn, like, liker `notificationModes` in, notIn For `trackingEndTime`, value `0` represents never-expiring tracking. Nested filter composition is supported through `logicalOperator` and nested `filters`. Only one level of nested filters is supported.
filters list / elements=dictionary	Nested tracked-client filters used with `logicalOperator`. Child filters cannot contain nested `filters` of their own.
filters list / elements=dictionary	Nested tracked-client filters used with `logicalOperator`. Child filters cannot contain nested `filters` of their own.
filters list / elements=dictionary	Nested tracked-client filters used with `logicalOperator`. Child filters cannot contain nested `filters` of their own.
filters list / elements=dictionary	Nested tracked-client filters used with `logicalOperator`. Child filters cannot contain nested `filters` of their own.
filters list / elements=dictionary	Nested tracked-client filters used with `logicalOperator`. Child filters cannot contain nested `filters` of their own.
key string	Supported tracked-client fields for request-body query filtering.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Value or values to apply with the filter operator. Depending on the field and operator, this may be a string, number, boolean, or array of scalar values.
key string	Supported tracked-client fields for request-body query filtering.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Value or values to apply with the filter operator. Depending on the field and operator, this may be a string, number, boolean, or array of scalar values.
key string	Supported tracked-client fields for request-body query filtering.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Value or values to apply with the filter operator. Depending on the field and operator, this may be a string, number, boolean, or array of scalar values.
key string	Supported tracked-client fields for request-body query filtering.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Value or values to apply with the filter operator. Depending on the field and operator, this may be a string, number, boolean, or array of scalar values.
key string	Supported tracked-client fields for request-body query filtering.
logicalOperator string	Operator to use when attempting to apply a logical conjunction of more than 1 filter Logical operations include 'and', 'or'.
operator string	Type of filter operator to use for querying data \| in and out operator takes multiple values and applies the filters.
value dictionary	Value or values to apply with the filter operator. Depending on the field and operator, this may be a string, number, boolean, or array of scalar values.
headers dictionary	Additional headers.
page dictionary	Pagination input for tracked-client queries.
limit integer	Maximum number of tracked-client records to return in one page.
offset integer	One-based starting offset for the tracked-client query results.
sortBy list / elements=dictionary	Sort fields applied before pagination. Only single-field sorting is supported on this API.
name string	Supported tracked-client fields for request-body sorting.
order string	Sort order. 'asc' for ascending and 'desc' for descending.
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 clients.Clients.query_tracked_client_configurations_with_request_body_filters,
Paths used are post /dna/intent/api/v1/trackedClients/query,
Does not support check_mode
The 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)

Examples 

---
- name: Create
  cisco.catalystcenter.tracked_clients_query_create:
    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}}"
    filters:
      - filters:
          - filters:
              - filters:
                  - filters:
                      - filters:
                          - {}
                        key: string
                        logicalOperator: string
                        operator: string
                        value: {}
                    key: string
                    logicalOperator: string
                    operator: string
                    value: {}
                key: string
                logicalOperator: string
                operator: string
                value: {}
            key: string
            logicalOperator: string
            operator: string
            value: {}
        key: string
        logicalOperator: string
        operator: string
        value: {}
    headers: '{{my_headers | from_json}}'
    page:
      limit: 0
      offset: 0
      sortBy:
        - name: string
          order: string

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"page": {"count": 0, "limit": 0, "offset": 0, "sortBy": [{"name": "string", "order": "string"}]}, "response": [{"clientMacAddress": "string", "description": "string", "duid": "string", "id": "string", "isPresentOnNetwork": true, "lastDisconnectedTime": 0, "lastOnboardedTime": 0, "notificationModes": ["string"], "randomizedMacAddresses": ["string"], "trackingEndTime": 0, "trackingStartTime": 0}], "version": "string"}`

Authors

Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)

cisco.catalystcenter.tracked_clients_query_create module -- Resource module for Tracked Clients Query Create

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 