cisco.dnac.network_update – Resource module for Network Update

Note

This plugin is part of the cisco.dnac collection (version 3.0.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.network_update.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Manage operation update of the resource Network Update.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
settings
dictionary
Network Update's settings.
clientAndEndpoint_aaa
dictionary
Network Update's clientAndEndpoint_aaa.
additionalIp
list / elements=string
Network Update's additionalIp.
ipAddress
string
Mandatory for ISE servers.
network
string
Network Update's network.
protocol
string
Network Update's protocol.
servers
string
Network Update's servers.
sharedSecret
string
Supported only by ISE servers.
dhcpServer
list / elements=string
Network Update's dhcpServer.
dnsServer
dictionary
Network Update's dnsServer.
domainName
string
Can only contain alphanumeric characters or hyphen.
primaryIpAddress
string
Valid range 1.0.0.0 - 223.255.255.255.
secondaryIpAddress
string
Valid range 1.0.0.0 - 223.255.255.255.
messageOfTheday
dictionary
Network Update's messageOfTheday.
bannerMessage
string
Network Update's bannerMessage.
retainExistingBanner
boolean
    Choices:
  • no
  • yes
RetainExistingBanner flag.
netflowcollector
dictionary
Network Update's netflowcollector.
ipAddress
string
Network Update's ipAddress.
port
integer
Network Update's port.
network_aaa
dictionary
Network Update's network_aaa.
additionalIp
list / elements=string
Network Update's additionalIp.
ipAddress
string
Mandatory for ISE servers and for AAA consider this as additional Ip.
network
string
For AAA server consider it as primary IP and For ISE consider as Network.
protocol
string
Network Update's protocol.
servers
string
Server type supported by ISE and AAA.
sharedSecret
string
Supported only by ISE servers.
ntpServer
list / elements=string
Network Update's ntpServer.
snmpServer
dictionary
Network Update's snmpServer.
configureDnacIP
boolean
    Choices:
  • no
  • yes
ConfigureDnacIP flag.
ipAddresses
list / elements=string
Network Update's ipAddresses.
syslogServer
dictionary
Network Update's syslogServer.
configureDnacIP
boolean
    Choices:
  • no
  • yes
ConfigureDnacIP flag.
ipAddresses
list / elements=string
Network Update's ipAddresses.
timezone
string
Network Update's timezone.
siteId
string
SiteId path parameter. Site id to update the network settings which is associated with the site.

See Also

See also

Network Update reference

Complete reference of the Network Update object model.

Examples

- name: Update by id
  cisco.dnac.network_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}}"
    settings:
      clientAndEndpoint_aaa:
        additionalIp:
        - string
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      dhcpServer:
      - string
      dnsServer:
        domainName: string
        primaryIpAddress: string
        secondaryIpAddress: string
      messageOfTheday:
        bannerMessage: string
        retainExistingBanner: true
      netflowcollector:
        ipAddress: string
        port: 0
      network_aaa:
        additionalIp:
        - string
        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

- name: Create
  cisco.dnac.network_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}}"
    settings:
      clientAndEndpoint_aaa:
        additionalIp:
        - string
        ipAddress: string
        network: string
        protocol: string
        servers: string
        sharedSecret: string
      dhcpServer:
      - string
      dnsServer:
        domainName: string
        primaryIpAddress: string
        secondaryIpAddress: string
      messageOfTheday:
        bannerMessage: string
        retainExistingBanner: true
      netflowcollector:
        ipAddress: string
        port: 0
      network_aaa:
        additionalIp:
        - string
        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 Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "executionId": "string", "executionStatusUrl": "string", "message": "string" }


Authors

  • Rafael Campos (@racampos)