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.1.4).

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

• This module represents an alias of the module integration_settings_instances_itsm_v1

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_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.
Auth_Password string	Auth Password.
Auth_UserName 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_v1, itsm_integration.ItsmIntegration.delete_itsm_integration_setting_v1, itsm_integration.ItsmIntegration.update_itsm_integration_setting_v1,

• 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},

• It should be noted that this module is an alias of integration_settings_instances_itsm_v1

• 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for ITSM Integration CreateITSMIntegrationSettingV1

Complete reference of the CreateITSMIntegrationSettingV1 API.

Cisco DNA Center documentation for ITSM Integration DeleteITSMIntegrationSettingV1

Complete reference of the DeleteITSMIntegrationSettingV1 API.

Cisco DNA Center documentation for ITSM Integration UpdateITSMIntegrationSettingV1

Complete reference of the UpdateITSMIntegrationSettingV1 API.

Examples

- name: Create
  cisco.catalystcenter.integration_settings_instances_itsm:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    data:
      ConnectionSettings:
        Auth_Password: string
        Auth_UserName: string
        Url: string
    description: string
    dypName: string
    name: string
- name: Update by id
  cisco.catalystcenter.integration_settings_instances_itsm:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    data:
      ConnectionSettings:
        Auth_Password: string
        Auth_UserName: string
        Url: string
    description: string
    dypName: string
    instanceId: string
    name: string
- name: Delete by id
  cisco.catalystcenter.integration_settings_instances_itsm:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    instanceId: 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 DNAC 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)