/ home / cisco / cisco.dnac / 6.13.3 / module / interface_update

cisco.dnac.interface_update (6.13.3) — module

Resource module for Interface Update

| "added in version" 6.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

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.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Update by id
  cisco.dnac.interface_update:
    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}}"
    adminStatus: string
    deploymentMode: string
    description: string
    interfaceUuid: string
    vlanId: 0
    voiceVlanId: 0

Inputs

    
vlanId:
    description: Vlan Id.
    type: int

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

adminStatus:
    description: Admin Status.
    type: str

description:
    description: Description.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

voiceVlanId:
    description: Voice Vlan Id.
    type: int

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

interfaceUuid:
    description: InterfaceUuid path parameter. Interface ID.
    type: str

deploymentMode:
    description: DeploymentMode query parameter. Preview/Deploy 'Preview' means the configuration
      is not pushed to the device. 'Deploy' makes the configuration pushed to the device.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": {\n    \"type\": \"string\",\n    \"properties\": {\n\
    \      \"taskId\": {\n        \"type\": \"string\"\n      },\n      \"url\": {\n\
    \        \"type\": \"string\"\n      }\n    },\n    \"required\": [\n      \"\
    string\"\n    ]\n  },\n  \"version\": {\n    \"type\": \"string\"\n  }\n}\n"
  type: dict