cisco.dnac.qos_device_interface module – Resource module for Qos Device Interface
Note
This module is part of the cisco.dnac collection (version 6.20.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.qos_device_interface
.
New in cisco.dnac 4.0.0
Synopsis
Manage operations create, update and delete of the resource Qos Device Interface.
Create qos device interface infos associate with network device id to allow the user to mark specific interfaces as WAN, to associate WAN interfaces with specific SP Profile and to be able to define a shaper on WAN interfaces.
Delete all qos device interface infos associate with network device id.
Update existing qos device interface infos associate with network device id.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id. |
|
Qos Device Interface’s payload. |
|
Excluded interfaces ids. |
|
Id of Qos device info. |
|
Device name. |
|
Network device id. |
|
Qos Device Interface’s qosDeviceInterfaceInfo. |
|
Dmvpn remote sites bandwidth. |
|
Instance id. |
|
Interface id. |
|
Interface name. |
|
SP Profile name. |
|
Interface role. |
|
Upload bandwidth. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are application_policy.ApplicationPolicy.create_qos_device_interface_info, application_policy.ApplicationPolicy.delete_qos_device_interface_info, application_policy.ApplicationPolicy.update_qos_device_interface_info,
Paths used are post /dna/intent/api/v1/qos-device-interface-info, delete /dna/intent/api/v1/qos-device-interface-info/{id}, put /dna/intent/api/v1/qos-device-interface-info,
Does not support
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 DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Application Policy CreateQosDeviceInterfaceInfo
Complete reference of the CreateQosDeviceInterfaceInfo API.
- Cisco DNA Center documentation for Application Policy DeleteQosDeviceInterfaceInfo
Complete reference of the DeleteQosDeviceInterfaceInfo API.
- Cisco DNA Center documentation for Application Policy UpdateQosDeviceInterfaceInfo
Complete reference of the UpdateQosDeviceInterfaceInfo API.
Examples
- name: Update all
cisco.dnac.qos_device_interface:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
payload:
- excludedInterfaces:
- string
id: string
name: string
networkDeviceId: string
qosDeviceInterfaceInfo:
- dmvpnRemoteSitesBw:
- 0
instanceId: 0
interfaceId: string
interfaceName: string
label: string
role: string
uploadBW: 0
- name: Create
cisco.dnac.qos_device_interface:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
payload:
- excludedInterfaces:
- string
name: string
networkDeviceId: string
qosDeviceInterfaceInfo:
- dmvpnRemoteSitesBw:
- 0
interfaceId: string
interfaceName: string
label: string
role: string
uploadBW: 0
- name: Delete by id
cisco.dnac.qos_device_interface:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: absent
id: 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 DNAC Python SDK Returned: always Sample: |