cisco.catalystcenter.qos_device_interface module -- Resource module for Qos Device Interface

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

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

New in cisco.catalystcenter 4.0.0

Synopsis

• This module represents an alias of the module qos_device_interface_v1

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
id string	Id path parameter. Id of the qos device info, this object holds all qos device interface infos associate with network device id.
payload list / elements=dictionary	Qos Device Interface's payload.
excludedInterfaces list / elements=string	Excluded interfaces ids.
id string	Id of Qos device info.
name string	Device name.
networkDeviceId string	Network device id.
qosDeviceInterfaceInfo list / elements=dictionary	Qos Device Interface's qosDeviceInterfaceInfo.
dmvpnRemoteSitesBw list / elements=integer	Dmvpn remote sites bandwidth.
instanceId integer	Instance id.
interfaceId string	Interface id.
interfaceName string	Interface name.
label string	SP Profile name.
role string	Interface role.
uploadBW integer	Upload bandwidth.
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 application_policy.ApplicationPolicy.create_qos_device_interface_info_v1, application_policy.ApplicationPolicy.delete_qos_device_interface_info_v1, application_policy.ApplicationPolicy.update_qos_device_interface_info_v1,

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

• It should be noted that this module is an alias of qos_device_interface_v1

• 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Application Policy CreateQosDeviceInterfaceInfoV1

Complete reference of the CreateQosDeviceInterfaceInfoV1 API.

Cisco DNA Center documentation for Application Policy DeleteQosDeviceInterfaceInfoV1

Complete reference of the DeleteQosDeviceInterfaceInfoV1 API.

Cisco DNA Center documentation for Application Policy UpdateQosDeviceInterfaceInfoV1

Complete reference of the UpdateQosDeviceInterfaceInfoV1 API.

Examples

- name: Update all
  cisco.catalystcenter.qos_device_interface:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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.catalystcenter.qos_device_interface:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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.catalystcenter.qos_device_interface:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    id: 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 DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)