cisco.catalystcenter.network_device_licenses_query_create module -- Resource module for Network Device Licenses 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.network_device_licenses_query_create.
New in cisco.catalystcenter 2.11.0
Synopsis
Manage operation create of the resource Network Device Licenses Query Create.
API to retrieve the list of network devices and their licenses, 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 |
|---|---|
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"` |
|
Network Device Licenses Query Create's filter. |
|
List of filter criteria to query network devices. |
|
The key to filter by. |
|
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 to filter by. For `in` operator, the value should be a list of values. |
|
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. |. |
|
Query filter for pagination and sorting. |
|
The maximum number of items to return in a single response. This determines the size of each "page" of results. For example, a value of 10 will return up to 10 items. The maximum allowed value is 500. |
|
The number of items to skip before starting to collect the result set. Use this to retrieve subsequent "pages" of results. For example, an offset of 10 will skip the first 10 items. |
|
A property within the response to sort by. |
|
The name of the field to sort by. |
|
The sort order. |
|
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_with_filters,
Paths used are post /dna/intent/api/v1/networkDeviceLicenses/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 Licenses QueryNetworkDevicesLicensesWithFilters
Complete reference of the QueryNetworkDevicesLicensesWithFilters API.
Examples
---
- name: Create
cisco.catalystcenter.network_device_licenses_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}}"
filter:
filters:
- key: string
operator: string
value: {}
logicalOperator: string
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 |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always |