cisco.catalystcenter.interface_update module -- Resource module for Interface Update

Note

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

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

New in cisco.catalystcenter 6.0.0

Synopsis

• Manage operation update of the resource Interface Update. - > Add/Update Interface description, VLAN membership, Voice VLAN and change Interface admin status 'UP'/'DOWN' from Request body.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
adminStatus string	Admin status as ('UP'/'DOWN').
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
deploymentMode string	DeploymentMode query parameter. Preview/Deploy 'Preview' means the configuration is not pushed to the device. 'Deploy' makes the configuration pushed to the device.
description string	Description for the Interface.
interfaceUuid string	InterfaceUuid path parameter. Interface ID.
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)
vlanId integer	VLAN Id to be Updated.
voiceVlanId integer	Voice Vlan Id to be Updated.

Notes

Note

• SDK Method used are devices.Devices.update_interface_details,

• Paths used are put /dna/intent/api/v1/interface/{interfaceUuid},

• 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

See Also

See also

Cisco DNA Center documentation for Devices UpdateInterfaceDetails

Complete reference of the UpdateInterfaceDetails API.

Examples

---
- name: Update by id
  cisco.catalystcenter.interface_update:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    adminStatus: string
    deploymentMode: string
    description: string
    interfaceUuid: string
    vlanId: 0
    voiceVlanId: 0

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"properties": {"taskId": {"type": "string"}, "url": {"type": "string"}}, "required": ["string"], "type": "string"}, "version": {"type": "string"}}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)