cisco.catalystcenter.network_devices_update_create module -- Resource module for Network Devices Update Create

Note

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

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

New in cisco.catalystcenter 2.3.0

Synopsis

  • Manage operation create of the resource Network Devices Update Create.

  • Updates specified fields of an existing network device. Only include the fields you wish to update.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

category

string

Category of the device. Used to determine the type of the device being added. | Category | Description | Required Credentials | Optional Credentials | | -------------------- | ----------------------------------------------------------------------------------... | -------------------- | -------------------- | | `NETWORK_DEVICE` | Standard Cisco network devices like switches, routers, controllers | CLI, SNMP | HTTP, Netconf | | `COMPUTE_DEVICE` | Server or computing system manufactured by Cisco such as Unified Computing System (UCS) | HTTP | CLI, SNMP | | `THIRD_PARTY_DEVICE` | Non-Cisco network devices that support SNMP monitoring | SNMP | - | | `MERAKI_DASHBOARD` | Cisco Meraki cloud-managed devices accessed via Meraki Dashboard | Meraki | - | | `FIREWALL_MANAGEMENT_CENTER` | Cisco Secure Firewall Management Center (FMC) | HTTP | - |.

credentials

dictionary

Credentials used to access the network device.

cli

dictionary

Network Devices Update Create's cli.

protocol

string

Protocol used for CLI access. Default is SSH.

http

dictionary

Network Devices Update Create's http.

protocol

string

HTTP protocol. Compute devices require HTTPS.

meraki

dictionary

Meraki credentials. Required if type is MERAKI_DASHBOARD.

apiKey

string

Meraki API key.

orgIds

list / elements=string

Meraki organizations for which the devices needs to be imported. Imports devices from all organizations if not provided.

netconf

dictionary

NETCONF credentials used to access the network device. The credentials are used to access the device using NETCONF.

snmp

dictionary

Extra properties for SNMP credentials.

retries

integer

SNMP retry. Default is Global SNMP retry (if exists) or 3.

timeout

integer

SNMP timeout in seconds. Default is Global SNMP timeout (if exists) or 5.

id

string

Id path parameter. Unique identifier of the network device.

managementAddress

dictionary

Either an IP address or a fully-qualified domain name.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are devices.Devices.partially_updates_an_existing_network_device,

  • Paths used are post /dna/intent/api/v1/networkDevices/{id}/update,

  • 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Devices PartiallyUpdatesAnExistingNetworkDevice

Complete reference of the PartiallyUpdatesAnExistingNetworkDevice API.

Examples

---
- name: Create
  cisco.catalystcenter.network_devices_update_create:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    category: string
    credentials:
      cli: {}
      http: {}
      meraki:
        apiKey: string
        orgIds:
          - string
      netconf: {}
      snmp: {}
    id: string
    managementAddress: {}

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)