.. 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-entry .. role:: ansible-option-default .. 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 5.0.0). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.network_create`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Network Create. - API to create a 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 == 2.4.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-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. 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:`string` .. 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:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (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.2.3.3"` .. 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). Mandatory for ISE servers. .. 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. Supported only by ISE servers. .. 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 serve 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). It can only contain alphanumeric characters or hyphen. .. 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). Valid range 1.0.0.0 - 223.255.255.255. .. 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). Valid range 1.0.0.0 - 223.255.255.255. .. 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). Mandatory for ISE servers and for AAA consider this as additional Ip. .. 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). For AAA server consider it as primary IP and For ISE consider as Network. .. 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. Supported only by ISE servers. .. 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:`no` - :ansible-option-choices-entry:`yes` .. 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:`no` - :ansible-option-choices-entry:`yes` .. 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:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (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 .. 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}}" 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:` "{\\n \\"executionId\\": \\"string\\",\\n \\"executionStatusUrl\\": \\"string\\",\\n \\"message\\": \\"string\\"\\n}\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors