#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright (c) 2021, Cisco Systems # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) DOCUMENTATION = r""" --- module: network_device short_description: Resource module for Network Device description: - This module represents an alias of the module network_device_v1 version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module author: Rafael Campos (@racampos) options: cleanConfig: description: CleanConfig query parameter. Selecting the clean up configuration option will attempt to remove device settings that were configured during the addition of the device to the inventory and site assignment. Please note that this operation is different from deprovisioning. It does not remove configurations that were pushed during device provisioning. type: bool version_added: 4.0.0 cliTransport: description: CLI transport. Supported values telnet, ssh. Required if type is NETWORK_DEVICE. type: str computeDevice: description: Compute Device or not. Options are true / false. type: bool enablePassword: description: CLI enable password of the device. Required if device is configured to use enable password. type: str extendedDiscoveryInfo: description: This field holds that info as whether to add device with canned data or not. Supported values DISCOVER_WITH_CANNED_DATA. type: str httpPassword: description: HTTP password of the device / API key for Meraki Dashboard. Required if type is MERAKI_DASHBOARD or COMPUTE_DEVICE. type: str httpPort: description: HTTP port of the device. Required if type is COMPUTE_DEVICE. type: str httpSecure: description: Flag to select HTTP / HTTPS protocol. Options are true / false. True for HTTPS and false for HTTP. Default is true. type: bool httpUserName: description: HTTP Username of the device. Required if type is COMPUTE_DEVICE. type: str id: description: Id path parameter. Device ID. type: str ipAddress: description: IP Address of the device. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. elements: str type: list merakiOrgId: description: Selected Meraki organization for which the devices needs to be imported. Required if type is MERAKI_DASHBOARD. elements: str type: list netconfPort: description: Netconf Port of the device. CliTransport must be 'ssh' if netconf is provided. Netconf port is required for eWLC. type: str password: description: CLI Password of the device. Required if type is NETWORK_DEVICE. type: str serialNumber: description: Serial Number of the Device. Required if extendedDiscoveryInfo is 'DISCOVER_WITH_CANNED_DATA'. type: str snmpAuthPassphrase: description: SNMPv3 auth passphrase of the device. Required if snmpMode is authNoPriv or authPriv. type: str snmpAuthProtocol: description: SNMPv3 auth protocol. Supported values sha, md5. Required if snmpMode is authNoPriv or authPriv. type: str snmpMode: description: SNMPv3 mode. Supported values noAuthnoPriv, authNoPriv, authPriv. Required if snmpVersion is v3. type: str snmpPrivPassphrase: description: SNMPv3 priv passphrase. Required if snmpMode is authPriv. type: str snmpPrivProtocol: description: SNMPv3 priv protocol. Supported values AES128. Required if snmpMode is authPriv. type: str snmpROCommunity: description: SNMP Read Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. type: str snmpRWCommunity: description: SNMP Write Community of the device. If snmpVersion is v2, at least one of snmpROCommunity and snmpRWCommunity is required. type: str snmpRetry: description: SNMP retry count. Max value supported is 3. Default is Global SNMP retry (if exists) or 3. type: int snmpTimeout: description: SNMP timeout in seconds. Max value supported is 300. Default is Global SNMP timeout (if exists) or 5. type: int snmpUserName: description: SNMPV3 user name of the device. Required if snmpVersion is v3. type: str snmpVersion: description: SNMP version. Values supported v2, v3. Required if type is NETWORK_DEVICE, COMPUTE_DEVICE or THIRD_PARTY_DEVICE. type: str type: description: Type of device being added. Default is NETWORK_DEVICE. type: str updateMgmtIPaddressList: description: Network Device's updateMgmtIPaddressList. elements: dict suboptions: existMgmtIpAddress: description: ExistMgmtIpAddress IP Address of the device. type: str newMgmtIpAddress: description: New IP Address to be Updated. type: str type: list userName: description: CLI user name of the device. Required if type is NETWORK_DEVICE. type: str requirements: - dnacentersdk >= 2.4.9 - python >= 3.5 seealso: - name: Cisco DNA Center documentation for Devices AddDeviceKnowYourNetworkV1 description: Complete reference of the AddDeviceKnowYourNetworkV1 API. link: https://developer.cisco.com/docs/dna-center/#!add-device-know-your-network - name: Cisco DNA Center documentation for Devices DeleteDeviceByIdV1 description: Complete reference of the DeleteDeviceByIdV1 API. link: https://developer.cisco.com/docs/dna-center/#!delete-device-by-id - name: Cisco DNA Center documentation for Devices UpdateDeviceDetailsV1 description: Complete reference of the UpdateDeviceDetailsV1 API. link: https://developer.cisco.com/docs/dna-center/#!update-device-details notes: - SDK Method used are devices.Devices.add_device, devices.Devices.delete_device_by_id_v1, devices.Devices.sync_devices, - Paths used are post /dna/intent/api/v1/network-device, delete /dna/intent/api/v1/network-device/{id}, put /dna/intent/api/v1/network-device, - It should be noted that this module is an alias of network_device_v1 - Removed 'managementIpAddress' options in v4.3.0. """ EXAMPLES = r""" - name: Create cisco.dnac.network_device: 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 cliTransport: string computeDevice: true enablePassword: string extendedDiscoveryInfo: string httpPassword: string httpPort: string httpSecure: true httpUserName: string ipAddress: - string merakiOrgId: - string netconfPort: string password: string serialNumber: string snmpAuthPassphrase: string snmpAuthProtocol: string snmpMode: string snmpPrivPassphrase: string snmpPrivProtocol: string snmpROCommunity: string snmpRWCommunity: string snmpRetry: 0 snmpTimeout: 0 snmpUserName: string snmpVersion: string type: string userName: string - name: Update all cisco.dnac.network_device: 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 cliTransport: string computeDevice: true enablePassword: string extendedDiscoveryInfo: string httpPassword: string httpPort: string httpSecure: true httpUserName: string ipAddress: - string merakiOrgId: - string netconfPort: string password: string serialNumber: string snmpAuthPassphrase: string snmpAuthProtocol: string snmpMode: string snmpPrivPassphrase: string snmpPrivProtocol: string snmpROCommunity: string snmpRWCommunity: string snmpRetry: 0 snmpTimeout: 0 snmpUserName: string snmpVersion: string type: string updateMgmtIPaddressList: - existMgmtIpAddress: string newMgmtIpAddress: string userName: string - name: Delete by id cisco.dnac.network_device: 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 cleanConfig: true id: string """ RETURN = r""" dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always type: dict sample: > { "response": { "taskId": "string", "url": "string" }, "version": "string" } """