cisco.dnac.ipam_server_setting module -- Resource module for Ipam Server Setting

Note

This module is part of the cisco.dnac collection (version 6.42.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.15.0

Synopsis

• Manage operations create, update and delete of the resource Ipam Server Setting. - > Creates configuration details of the external IPAM server. You should only create one external IPAM server; delete any existing external server before creating a new one.

• Deletes configuration details of the external IPAM server.

• Updates configuration details of the external IPAM server.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.10.1

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
password string	The password for the external IPAM server login username.
provider string	Type of external IPAM. Can be either INFOBLOX, BLUECAT or GENERIC.
serverName string	A descriptive name of this external server, used for identification purposes.
serverUrl string	The URL of this external server.
syncView boolean	Synchronize the IP pools from the local IPAM to this external server. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
userName string	The external IPAM server login username.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
view string	The view under which pools are created in the external IPAM server.

Notes

Note

• SDK Method used are system_settings.SystemSettings.creates_configuration_details_of_the_external_ip_a_m_server, system_settings.SystemSettings.deletes_configuration_details_of_the_external_ip_a_m_server, system_settings.SystemSettings.updates_configuration_details_of_the_external_ip_a_m_server,

• Paths used are post /dna/intent/api/v1/ipam/serverSetting, delete /dna/intent/api/v1/ipam/serverSetting, put /dna/intent/api/v1/ipam/serverSetting,

• Does not support 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

See Also

See also

Cisco DNA Center documentation for System Settings CreatesConfigurationDetailsOfTheExternalIPAMServer

Complete reference of the CreatesConfigurationDetailsOfTheExternalIPAMServer API.

Cisco DNA Center documentation for System Settings DeletesConfigurationDetailsOfTheExternalIPAMServer

Complete reference of the DeletesConfigurationDetailsOfTheExternalIPAMServer API.

Cisco DNA Center documentation for System Settings UpdatesConfigurationDetailsOfTheExternalIPAMServer

Complete reference of the UpdatesConfigurationDetailsOfTheExternalIPAMServer API.

Examples

---
- name: Create
  cisco.dnac.ipam_server_setting:
    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}}"
    state: present
    password: string
    provider: string
    serverName: string
    serverUrl: string
    syncView: true
    userName: string
    view: string
- name: Delete all
  cisco.dnac.ipam_server_setting:
    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}}"
    state: absent
- name: Update all
  cisco.dnac.ipam_server_setting:
    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}}"
    state: present
    password: string
    serverName: string
    serverUrl: string
    syncView: true
    userName: string
    view: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)