cisco.dnac.network_create – Resource module for Network Create

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Manage operation create of the resource Network Create.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.3.1

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
settings
dictionary
Network Create's settings.
clientAndEndpoint_aaa
dictionary
Network Create's clientAndEndpoint_aaa.
additionalIp
list / elements=string
Additional IP for ISE server which is not supported by AAA server.
ipAddress
string
IP address for ISE serve (eg 1.1.1.4). Mandatory for ISE servers.
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. Supported only by ISE servers.
dhcpServer
list / elements=string
Dhcp serve Ip (eg 1.1.1.1).
dnsServer
dictionary
Network Create's dnsServer.
domainName
string
Domain name of DHCP (eg; cisco). Can only contain alphanumeric characters or hyphen.
primaryIpAddress
string
Primary ip address for DHCP (eg 2.2.2.2). Valid range 1.0.0.0 - 223.255.255.255.
secondaryIpAddress
string
Secondary ip address for DHCP (eg 3.3.3.3). Valid range 1.0.0.0 - 223.255.255.255.
messageOfTheday
dictionary
Network Create's messageOfTheday.
bannerMessage
string
Massage for banner message (eg; Good day).
retainExistingBanner
boolean
    Choices:
  • no
  • yes
Retain existing banner message (eg true).
netflowcollector
dictionary
Network Create's netflowcollector.
ipAddress
string
IP address for netflow collector (eg 3.3.3.1).
port
integer
Port for netflow collector (eg; 443).
network_aaa
dictionary
Network Create's network_aaa.
additionalIp
list / elements=string
Additional IP for ISE server which is not supported by AAA server.
ipAddress
string
IP address for AAA and ISE server (eg 1.1.1.1). Mandatory for ISE servers and for AAA consider this as additional Ip.
network
string
IP address for AAA or ISE server (eg 2.2.2.2). For AAA server consider it as primary IP and For ISE consider as Network.
protocol
string
Protocol for AAA or ISE serve (eg RADIUS).
servers
string
Server type for AAA network (eg AAA). Server type supported by ISE and AAA.
sharedSecret
string
Shared secret for ISE server. Supported only by ISE servers.
ntpServer
list / elements=string
IP address for NTP server (eg 1.1.1.2).
snmpServer
dictionary
Network Create's snmpServer.
configureDnacIP
boolean
    Choices:
  • no
  • yes
Configuration dnac ip for snmp server (eg true).
ipAddresses
list / elements=string
IP address for snmp server (eg 4.4.4.1).
syslogServer
dictionary
Network Create's syslogServer.
configureDnacIP
boolean
    Choices:
  • no
  • yes
Configuration dnac ip for syslog server (eg true).
ipAddresses
list / elements=string
IP address for syslog server (eg 4.4.4.4).
timezone
string
Input for time zone (eg Africa/Abidjan (GMT)).
siteId
string
SiteId path parameter. Site id to which site details to associate with the network settings.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

  • Does not support check_mode

See Also

See also

Network Create reference

Complete reference of the Network Create object model.

Examples

- name: Create
  cisco.dnac.network_create:
    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: Update by id
  cisco.dnac.network_create:
    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)