cisco.catalystcenter.network_device_licenses_query_count_create module -- Resource module for Network Device Licenses Query Count Create

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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.network_device_licenses_query_count_create.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation create of the resource Network Device Licenses Query Count Create.

  • API to retrieve the number of network devices, determined by the 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:

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:

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"`

filter

dictionary

Filter to query network devices. The result will contain the network devices that match all the filter criteria (AND condition) unless specified in 'logicalOperator'. Total number of filter criteria should not exceed 20.

filters

list / elements=dictionary

List of filter criteria to query network devices.

key

string

The key to filter by.

operator

string

The operator to use for filtering the values. | Operator | Description | |-----------|--------------------------------------------------------------------------... | `eq` | The result will include entities whose attribute values have the network devices that match the exact value. | | `contains`| The result will include entities whose attribute values have the network devices that contain the value. | | `in` | The result will include entities whose attribute values match any of the values in the list. | | `lt` | The result will include entities whose attribute values are less than the specified value. | | `gt` | The result will include entities whose attribute values are greater than the specified value. | | `lte` | The result will include entities whose attribute values are less than or equal to the specified value. | | `gte` | The result will include entities whose attribute values are greater than or equal to the specified value. |.

value

dictionary

Value to filter by. For `in` operator, the value should be a list of values.

logicalOperator

string

The logical operator to use for combining the filter criteria. If not provided, the default value is `AND`. | Logical operator | Description | |-------------|----------------------------------------------------------------------------------------... | `AND` | The result will contain the network devices that match all the filter criteria. | | `OR` | The result will contain the network devices that match ANY of the filter criteria. |.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are licenses.Licenses.query_network_devices_licenses_count_with_filters,

  • Paths used are post /dna/intent/api/v1/networkDeviceLicenses/query/count,

  • 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)

See Also

See also

Cisco Catalyst Center documentation for Licenses QueryNetworkDevicesLicensesCountWithFilters

Complete reference of the QueryNetworkDevicesLicensesCountWithFilters API.

Examples

---
- name: Create
  cisco.catalystcenter.network_device_licenses_query_count_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}}"
    filter: {}

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:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)