cisco.catalystcenter.integration_settings_instances_itsm module -- Resource module for Integration Settings Instances Itsm

Note

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

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

New in cisco.catalystcenter 3.1.0

Synopsis

• Manage operations create, update and delete of the resource Integration Settings Instances Itsm.

• Creates ITSM Integration setting.

• Deletes the ITSM Integration setting.

• Updates the ITSM Integration setting.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
data dictionary	Integration Settings Instances Itsm's data.
ConnectionSettings dictionary	Integration Settings Instances Itsm's ConnectionSettings.
Authpassword string	Auth Password.
Authusername string	Auth User Name.
Url string	Url.
description string	Description of the setting instance.
dypName string	It can be ServiceNowConnection.
instanceId string	InstanceId path parameter. Instance Id of the Integration setting instance.
name string	Name of the setting instance.
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 itsm_integration.ItsmIntegration.create_itsm_integration_setting, itsm_integration.ItsmIntegration.delete_itsm_integration_setting, itsm_integration.ItsmIntegration.update_itsm_integration_setting,

• Paths used are post /dna/intent/api/v1/integration-settings/instances/itsm, delete /dna/intent/api/v1/integration-settings/instances/itsm/{instanceId}, put /dna/intent/api/v1/integration-settings/instances/itsm/{instanceId},

• 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

See Also

See also

Cisco DNA Center documentation for ITSM Integration CreateITSMIntegrationSetting

Complete reference of the CreateITSMIntegrationSetting API.

Cisco DNA Center documentation for ITSM Integration DeleteITSMIntegrationSetting

Complete reference of the DeleteITSMIntegrationSetting API.

Cisco DNA Center documentation for ITSM Integration UpdateITSMIntegrationSetting

Complete reference of the UpdateITSMIntegrationSetting API.

Examples

---
- name: Create
  cisco.catalystcenter.integration_settings_instances_itsm:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    data:
      ConnectionSettings:
        Authpassword: string
        Authusername: string
        Url: string
    description: string
    dypName: string
    name: string
- name: Update by id
  cisco.catalystcenter.integration_settings_instances_itsm:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    data:
      ConnectionSettings:
        Authpassword: string
        Authusername: string
        Url: string
    description: string
    dypName: string
    instanceId: string
    name: string
- name: Delete by id
  cisco.catalystcenter.integration_settings_instances_itsm:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    instanceId: 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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"createdBy": "string", "createdDate": 0, "data": {"ConnectionSettings": {"Auth\_Password": "string", "Auth\_UserName": "string", "Url": "string"}}, "description": "string", "dypId": "string", "dypMajorVersion": 0, "dypName": "string", "id": "string", "name": "string", "schemaVersion": 0, "softwareVersionLog": [{}], "tenantId": "string", "uniqueKey": "string", "updatedBy": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)