cisco.dnac.wired_network_devices_id_config_features_intended_layer2_info module -- Information module for Wired Network Devices Id Config Features Intended Layer2

Note

This module is part of the cisco.dnac collection (version 6.46.0).

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

New in cisco.dnac 6.18.0

Synopsis

  • Get all Wired Network Devices Id Config Features Intended Layer2.

  • This API returns the configurations for the intended layer 2 features on a wired device.

  • Even after the intended configurations are deployed using the deploy API, they continue to be a part of the intended features on the device.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

feature

string

Feature query parameter. Name of the feature to configure. The API /data/intent/api/wired/networkDevices/{id}/configFeatures/supported/layer2 can be used to get the list of features supported on a device.

headers

dictionary

Additional headers.

id

string

Id path parameter. Network device ID of the wired device to configure.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are wired.Wired.get_configurations_for_intended_layer2_features_on_a_wired_device,

  • Paths used are get /dna/intent/api/v1/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2,

  • Supports 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 Wired GetConfigurationsForIntendedLayer2FeaturesOnAWiredDevice

Complete reference of the GetConfigurationsForIntendedLayer2FeaturesOnAWiredDevice API.

Examples

---
- name: Get all Wired Network Devices Id Config Features Intended Layer2
  cisco.dnac.wired_network_devices_id_config_features_intended_layer2_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    feature: string
    id: string
  register: result

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 DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"features": {"cdpGlobalConfig": {"items": [{"configType": "string", "holdTime": 0, "isAdvertiseV2Enabled": true, "isCdpEnabled": true, "isLogDuplexMismatchEnabled": true, "timer": 0}]}, "cdpInterfaceConfig": {"items": [{"configType": "string", "interfaceName": "string", "isCdpEnabled": true, "isLogDuplexMismatchEnabled": true}]}, "dhcpSnoopingGlobalConfig": {"items": [{"configType": "string", "databaseAgent": {"agentUrl": "string", "timeout": 0, "writeDelay": 0}, "isDhcpSnoopingEnabled": true, "isGleaningEnabled": true, "proxyBridgeVlans": "string"}]}, "dhcpSnoopingInterfaceConfig": {"items": [{"configType": "string", "interfaceName": "string", "isTrustedInterface": true}]}, "dot1xGlobalConfig": {"items": [{"authenticationConfigMode": "string", "configType": "string", "isDot1xEnabled": true}]}, "dot1xInterfaceConfig": {"items": [{"authenticationMode": "string", "authenticationOrder": {"configType": "string", "items": ["string"]}, "configType": "string", "inactivityTimer": 0, "interfaceName": "string", "isInactivityTimerFromServerEnabled": true, "isReauthEnabled": true, "isReauthTimerFromServerEnabled": true, "maxReauthRequests": 0, "priority": {"configType": "string", "items": ["string"]}, "reauthTimer": 0, "txPeriod": 0}]}, "igmpSnoopingGlobalConfig": {"items": [{"configType": "string", "igmpSnoopingVlanSettings": {"configType": "string", "items": [{"configType": "string", "igmpSnoopingVlanMrouters": {"configType": "string", "items": [{"configType": "string", "interfaceName": "string"}]}, "isIgmpSnoopingEnabled": true, "isImmediateLeaveEnabled": true, "isQuerierEnabled": true, "querierQueryInterval": 0, "vlanId": 0}]}, "isIgmpSnoopingEnabled": true, "isQuerierEnabled": true, "querierQueryInterval": 0, "querierVersion": "string"}]}, "lldpGlobalConfig": {"items": [{"configType": "string", "holdTime": 0, "isLldpEnabled": true, "reinitializationDelay": 0, "timer": 0}]}, "lldpInterfaceConfig": {"items": [{"adminStatus": "string", "configType": "string", "interfaceName": "string"}]}, "mabInterfaceConfig": {"items": [{"configType": "string", "interfaceName": "string", "isMabEnabled": true}]}, "mldSnoopingGlobalConfig": {"items": [{"configType": "string", "isMldSnoopingEnabled": true, "isQuerierEnabled": true, "mldSnoopingVlanSettings": {"configType": "string", "items": [{"configType": "string", "isImmediateLeaveEnabled": true, "isMldSnoopingEnabled": true, "isQuerierEnabled": true, "mldSnoopingVlanMrouters": {"configType": "string", "items": ["string"]}, "querierQueryInterval": 0, "vlanId": 0}]}, "querierQueryInterval": 0, "querierVersion": "string"}]}, "portchannelConfig": {"items": [{"configType": "string", "isAutoEnabled": true, "lacpSystemPriority": 0, "loadBalancingMethod": "string", "portchannels": {"configType": "string", "items": [{"configType": "string", "isLayer2": true, "memberPorts": {"configType": "string", "items": ["string"]}, "name": "string"}]}}]}, "stpGlobalConfig": {"items": [{"configType": "string", "isBackboneFastEnabled": true, "isBpduFilterEnabled": true, "isBpduGuardEnabled": true, "isEtherChannelGuardEnabled": true, "isExtendedSystemIdEnabled": true, "isLoggingEnabled": true, "isLoopGuardEnabled": true, "isUplinkFastEnabled": true, "portFastMode": "string", "stpInstances": {"configType": "string", "items": [{"configType": "string", "isStpEnabled": true, "priority": 0, "vlanId": 0}]}, "stpMode": "string", "transmitHoldCount": 0, "uplinkFastMaxUpdateRate": 0}]}, "stpInterfaceConfig": {"items": [{"bpduFilter": "string", "bpduGuard": "string", "configType": "string", "guardMode": "string", "interfaceName": "string", "pathCost": 0, "portVlanCostSettings": {"configType": "string", "items": [{"configType": "string", "cost": 0, "vlans": "string"}]}, "portVlanPrioritySettings": {"configType": "string", "items": [{"configType": "string", "priority": 0, "vlans": "string"}]}, "priority": 0}]}, "switchportInterfaceConfig": {"items": [{"accessVlan": 0, "adminStatus": "string", "configType": "string", "description": "string", "interfaceName": "string", "mode": "string", "nativeVlan": 0, "trunkAllowedVlans": "string"}]}, "trunkInterfaceConfig": {"items": [{"configType": "string", "interfaceName": "string", "isDtpNegotiationEnabled": true, "isProtected": true, "pruneEligibleVlans": "string"}]}, "vlanConfig": {"items": [{"configType": "string", "isVlanEnabled": true, "name": "string", "vlanId": 0}]}, "vtpGlobalConfig": {"items": [{"configType": "string", "configurationFileName": "string", "isPruningEnabled": true, "mode": "string", "sourceInterface": "string", "version": "string"}]}, "vtpInterfaceConfig": {"items": [{"configType": "string", "interfaceName": "string", "isVtpEnabled": true}]}}}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)