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

Note

This module is part of the cisco.catalystcenter collection (version 2.12.0).

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

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

New in cisco.catalystcenter 1.0.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. To enable communication with an external IPAM server that has a certificate that may not be trusted, add the certificate via `POST /intent/api/v1/trustedCertificates/import`.

• 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.

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
password string	The password for the external IPAM server login username.
provider string	Type of external IPAM.
serverName string	A descriptive name of this external server, used for identification purposes.
serverUrl string	The URL of this external server.
state_ string	State of the the external IPAM. * OK indicates success of most recent periodic communication check with external IPAM. * CRITICAL indicates failure of most recent attempt to communicate with the external IPAM. * SYNCHRONIZING indicates that the process of synchronizing the external IPAM database with the local IPAM database is running and all other IPAM processes will be blocked until the completes. * DISCONNECTED indicates the external IPAM is no longer being used.
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 Catalyst 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_ipam_server, system_settings.SystemSettings.deletes_configuration_details_of_the_external_ipam_server, system_settings.SystemSettings.updates_configuration_details_of_the_external_ipam_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 uses the embedded connection manager from Cisco CATALYST SDK

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for System Settings CreatesConfigurationDetailsOfTheExternalIPAMServer

Complete reference of the CreatesConfigurationDetailsOfTheExternalIPAMServer API.

Cisco Catalyst Center documentation for System Settings DeletesConfigurationDetailsOfTheExternalIPAMServer

Complete reference of the DeletesConfigurationDetailsOfTheExternalIPAMServer API.

Cisco Catalyst Center documentation for System Settings UpdatesConfigurationDetailsOfTheExternalIPAMServer

Complete reference of the UpdatesConfigurationDetailsOfTheExternalIPAMServer API.

Examples

---
- name: Create
  cisco.catalystcenter.ipam_server_setting:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    password: string
    provider: {}
    serverName: string
    serverUrl: string
    state_: string
    syncView: true
    userName: string
    view: string
- name: Update all
  cisco.catalystcenter.ipam_server_setting:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    password: string
    provider: {}
    serverName: string
    serverUrl: string
    state_: string
    syncView: true
    userName: string
    view: string
- name: Delete all
  cisco.catalystcenter.ipam_server_setting:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent

Return Values

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

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

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)