cisco.catalystcenter.location_servers_cmx_servers module -- Resource module for Location Servers Cmx Servers

Note

This module is part of the cisco.catalystcenter collection (version 2.11.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.location_servers_cmx_servers.

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create, update and delete of the resource Location Servers Cmx Servers. - > Creates a CMX Server connection. Once added, you can associate the CMX Server to one or more Sites, using '/dna/intent/api/v1/sites/{id}/locationServerSettings'.

• Delete the CMX Server.

• Updates the CMX 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"`
connectionAddress dictionary	Either an IP address or a fully-qualified domain name.
id string	Id path parameter. The CMX Server resource Id.
password string	The password of the CMX Server user given.
username string	The CMX Server username. This user must have full API read and write access.
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)

Notes

Note

• SDK Method used are system_settings.SystemSettings.creates_a_cmx_server_setting, system_settings.SystemSettings.delete_a_cmx_server_setting, system_settings.SystemSettings.updates_a_cmx_server_setting,

• Paths used are post /dna/intent/api/v1/locationServers/cmxServers, delete /dna/intent/api/v1/locationServers/cmxServers/{id}, put /dna/intent/api/v1/locationServers/cmxServers/{id},

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

Complete reference of the CreatesACMXServerSetting API.

Cisco Catalyst Center documentation for System Settings DeleteACMXServerSetting

Complete reference of the DeleteACMXServerSetting API.

Cisco Catalyst Center documentation for System Settings UpdatesACMXServerSetting

Complete reference of the UpdatesACMXServerSetting API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.location_servers_cmx_servers:
    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
    id: string
- name: Update by id
  cisco.catalystcenter.location_servers_cmx_servers:
    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
    connectionAddress: {}
    id: string
    password: string
    username: string
- name: Create
  cisco.catalystcenter.location_servers_cmx_servers:
    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
    connectionAddress: {}
    id: string
    password: string
    username: string

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)