.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.network_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.network -- Manage Network objects of NetworkSettings +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.network`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - API to get DHCP and DNS center server details. - API to create a Network for DHCP and DNS center server settings. - API to update Network for DHCP and DNS center server settings. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
settings
dictionary / required
Settings, property of the request body.
clientAndEndpoint_aaa
dictionary
It is the Network's clientAndEndpoint_aaa.
ipAddress
string
It is the Network's ipAddress.
network
string
It is the Network's Network.
protocol
string
It is the Network's protocol.
servers
string
It is the Network's servers.
sharedSecret
string
It is the Network's sharedSecret.
dhcpServer
list / elements=string
It is the Network's dhcpServer.
dnsServer
dictionary
It is the Network's dnsServer.
domainName
string
It is the Network's domainName.
primaryIpAddress
string
It is the Network's primaryIpAddress.
secondaryIpAddress
string
It is the Network's secondaryIpAddress.
messageOfTheday
dictionary
It is the Network's messageOfTheday.
bannerMessage
string
It is the Network's bannerMessage.
retainExistingBanner
boolean
    Choices:
  • no
  • yes
It is the Network's retainExistingBanner.
netflowcollector
dictionary
It is the Network's netflowcollector.
ipAddress
string
It is the Network's ipAddress.
port
integer
It is the Network's port.
network_aaa
dictionary
It is the Network's Network_aaa.
ipAddress
string
It is the Network's ipAddress.
network
string
It is the Network's Network.
protocol
string
It is the Network's protocol.
servers
string
It is the Network's servers.
sharedSecret
string
It is the Network's sharedSecret.
ntpServer
list / elements=string
It is the Network's ntpServer.
snmpServer
dictionary
It is the Network's snmpServer.
configureDnacIP
boolean
    Choices:
  • no
  • yes
It is the Network's configureDnacIP.
ipAddresses
list / elements=string
It is the Network's ipAddresses.
syslogServer
dictionary
It is the Network's syslogServer.
configureDnacIP
boolean
    Choices:
  • no
  • yes
It is the Network's configureDnacIP.
ipAddresses
list / elements=string
It is the Network's ipAddresses.
timezone
string
It is the Network's timezone.
site_id
string
Site id to get the Network settings associated with the site.
Site id to which site details to associate with the Network settings.
Site id to update the Network settings which is associated with the site.
Required for states update and create.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.network ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.network** module. `Network reference `_ Complete reference of the Network object model. `Network reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: get_network cisco.dnac.network: state: query # required site_id: SomeValue # string register: nm_get_network - name: create_network cisco.dnac.network: state: create # required site_id: SomeValue # string, required settings: # required dhcpServer: - SomeValue # string dnsServer: domainName: SomeValue # string primaryIpAddress: SomeValue # string secondaryIpAddress: SomeValue # string syslogServer: ipAddresses: - SomeValue # string configureDnacIP: True # boolean snmpServer: ipAddresses: - SomeValue # string configureDnacIP: True # boolean netflowcollector: ipAddress: SomeValue # string port: 1 # number ntpServer: - SomeValue # string timezone: SomeValue # string messageOfTheday: bannerMessage: SomeValue # string retainExistingBanner: True # boolean network_aaa: servers: SomeValue # string ipAddress: SomeValue # string network: SomeValue # string protocol: SomeValue # string sharedSecret: SomeValue # string clientAndEndpoint_aaa: servers: SomeValue # string ipAddress: SomeValue # string network: SomeValue # string protocol: SomeValue # string sharedSecret: SomeValue # string - name: update_network cisco.dnac.network: state: update # required site_id: SomeValue # string, required settings: # required dhcpServer: - SomeValue # string dnsServer: domainName: SomeValue # string primaryIpAddress: SomeValue # string secondaryIpAddress: SomeValue # string syslogServer: ipAddresses: - SomeValue # string configureDnacIP: True # boolean snmpServer: ipAddresses: - SomeValue # string configureDnacIP: True # boolean netflowcollector: ipAddress: SomeValue # string port: 1 # number ntpServer: - SomeValue # string timezone: SomeValue # string messageOfTheday: bannerMessage: SomeValue # string retainExistingBanner: True # boolean network_aaa: servers: SomeValue # string ipAddress: SomeValue # string network: SomeValue # string protocol: SomeValue # string sharedSecret: SomeValue # string clientAndEndpoint_aaa: servers: SomeValue # string ipAddress: SomeValue # string network: SomeValue # string protocol: SomeValue # string sharedSecret: SomeValue # string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
network_settings.create_network


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors