.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.network_create_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.network_create module -- Resource module for Network Create ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.10.3). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.network_create`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Network Create. - API to create a network for DHCP, Syslog, SNMP, NTP, Network AAA, Client and EndPoint AAA, and/or DNS center server settings. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.network_create_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.5.5 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.network_create_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.5.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings: .. rst-class:: ansible-option-title **settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/clientandendpoint_aaa: .. rst-class:: ansible-option-title **clientAndEndpoint_aaa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's clientAndEndpoint\_aaa. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/clientandendpoint_aaa/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for ISE serve (eg 1.1.1.4). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/clientandendpoint_aaa/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for AAA or ISE server (eg 2.2.2.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/clientandendpoint_aaa/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol for AAA or ISE serve (eg RADIUS). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/clientandendpoint_aaa/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server type AAA or ISE server (eg AAA). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/clientandendpoint_aaa/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret for ISE server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/dhcpserver: .. rst-class:: ansible-option-title **dhcpServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
DHCP Server IP (eg 1.1.1.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/dnsserver: .. rst-class:: ansible-option-title **dnsServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's dnsServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/dnsserver/domainname: .. rst-class:: ansible-option-title **domainName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Domain Name of DHCP (eg; cisco). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/dnsserver/primaryipaddress: .. rst-class:: ansible-option-title **primaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Primary IP Address for DHCP (eg 2.2.2.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/dnsserver/secondaryipaddress: .. rst-class:: ansible-option-title **secondaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Secondary IP Address for DHCP (eg 3.3.3.3). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/messageoftheday: .. rst-class:: ansible-option-title **messageOfTheday** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's messageOfTheday. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/messageoftheday/bannermessage: .. rst-class:: ansible-option-title **bannerMessage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Massage for Banner message (eg; Good day). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/messageoftheday/retainexistingbanner: .. rst-class:: ansible-option-title **retainExistingBanner** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Retain existing Banner Message (eg "true" or "false"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/netflowcollector: .. rst-class:: ansible-option-title **netflowcollector** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's netflowcollector. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/netflowcollector/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP Address for NetFlow collector (eg 3.3.3.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/netflowcollector/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port for NetFlow Collector (eg; 443). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/network_aaa: .. rst-class:: ansible-option-title **network_aaa** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's network\_aaa. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/network_aaa/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address for AAA and ISE server (eg 1.1.1.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/network_aaa/network: .. rst-class:: ansible-option-title **network** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP Address for AAA or ISE server (eg 2.2.2.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/network_aaa/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol for AAA or ISE serve (eg RADIUS). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/network_aaa/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Server type for AAA Network (eg AAA). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/network_aaa/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret for ISE Server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/ntpserver: .. rst-class:: ansible-option-title **ntpServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP address for NTP server (eg 1.1.1.2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/snmpserver: .. rst-class:: ansible-option-title **snmpServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's snmpServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/snmpserver/configurednacip: .. rst-class:: ansible-option-title **configureDnacIP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configuration DNAC IP for SNMP Server (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/snmpserver/ipaddresses: .. rst-class:: ansible-option-title **ipAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP Address for SNMP Server (eg 4.4.4.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/syslogserver: .. rst-class:: ansible-option-title **syslogServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Create's syslogServer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/syslogserver/configurednacip: .. rst-class:: ansible-option-title **configureDnacIP** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configuration DNAC IP for syslog server (eg true). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/syslogserver/ipaddresses: .. rst-class:: ansible-option-title **ipAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IP Address for syslog server (eg 4.4.4.4). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-settings/timezone: .. rst-class:: ansible-option-title **timezone** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Input for time zone (eg Africa/Abidjan). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SiteId path parameter. Site id to which site details to associate with the network settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are network\_settings.NetworkSettings.create\_network, - Paths used are post /dna/intent/api/v1/network/{siteId}, - Does not support \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Network Settings CreateNetwork `_ Complete reference of the CreateNetwork API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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}}" headers: '{{my_headers | from_json}}' 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.network_create_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors