cisco.dnac.network_update_v1 module – Resource module for Network Update V1

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 3.1.0

Synopsis

• Manage operation update of the resource Network Update V1.

• API to update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS server settings.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.9

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
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: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: "2.3.7.6"
settings dictionary	Network Update’s settings.
clientAndEndpoint_aaa dictionary	Network Update’s clientAndEndpoint_aaa.
ipAddress string	IP address for ISE serve (eg 1.1.1.4).
network string	IP address for AAA or ISE server (eg 2.2.2.1).
protocol string	Protocol for AAA or ISE serve (eg RADIUS).
servers string	Server type AAA or ISE server (eg AAA).
sharedSecret string	Shared secret for ISE server.
dhcpServer list / elements=string	DHCP Server IP (eg 1.1.1.1).
dnsServer dictionary	Network Update’s dnsServer.
domainName string	Domain Name of DHCP (eg; cisco).
primaryIpAddress string	Primary IP Address for DHCP (eg 2.2.2.2).
secondaryIpAddress string	Secondary IP Address for DHCP (eg 3.3.3.3).
messageOfTheday dictionary	Network Update’s messageOfTheday.
bannerMessage string	Massage for Banner message (eg; Good day).
retainExistingBanner string	Retain existing Banner Message (eg “true” or “false”).
netflowcollector dictionary	Network Update’s netflowcollector.
ipAddress string	IP Address for NetFlow collector (eg 3.3.3.1).
port float	Port for NetFlow Collector (eg; 443).
network_aaa dictionary	Network Update’s network_aaa.
ipAddress string	IP address for AAA and ISE server (eg 1.1.1.1).
network string	IP Address for AAA or ISE server (eg 2.2.2.2).
protocol string	Protocol for AAA or ISE serve (eg RADIUS).
servers string	Server type for AAA Network (eg AAA).
sharedSecret string	Shared secret for ISE Server.
ntpServer list / elements=string	IP address for NTP server (eg 1.1.1.2).
snmpServer dictionary	Network Update’s snmpServer.
configureDnacIP boolean	Configuration DNAC IP for SNMP Server (eg true). Choices: false true
ipAddresses list / elements=string	IP Address for SNMP Server (eg 4.4.4.1).
syslogServer dictionary	Network Update’s syslogServer.
configureDnacIP boolean	Configuration DNAC IP for syslog server (eg true). Choices: false true
ipAddresses list / elements=string	IP Address for syslog server (eg 4.4.4.4).
timezone string	Input for time zone (eg Africa/Abidjan).
siteId string	SiteId path parameter. Site id to update the network settings which is associated with the site.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

Notes

Note

• SDK Method used are network_settings.NetworkSettings.update_network_v1,

• Paths used are put /dna/intent/api/v1/network/{siteId},

• Does not support 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 Network Settings UpdateNetworkV1

Complete reference of the UpdateNetworkV1 API.

Examples

- name: Update by id
  cisco.dnac.network_update_v1:
    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}}"
    settings:
      clientAndEndpoint_aaa:
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      dhcpServer:
        - string
      dnsServer:
        domainName: string
        primaryIpAddress: string
        secondaryIpAddress: string
      messageOfTheday:
        bannerMessage: string
        retainExistingBanner: string
      netflowcollector:
        ipAddress: string
        port: 0
      network_aaa:
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      ntpServer:
        - string
      snmpServer:
        configureDnacIP: true
        ipAddresses:
          - string
      syslogServer:
        configureDnacIP: true
        ipAddresses:
          - string
      timezone: string
    siteId: string

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: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)