cisco.dnac.integration_settings_instances_itsm module – Resource module for Integration Settings Instances Itsm

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 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.

  • dnacentersdk >= 2.7.2

  • python >= 3.5

Parameters

Parameter

Comments

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.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • 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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

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 DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • 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 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 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.dnac.integration_settings_instances_itsm:
    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
    data:
      ConnectionSettings:
        Auth_Password: string
        Auth_UserName: string
        Url: string
    description: string
    dypName: string
    name: string

- name: Update by id
  cisco.dnac.integration_settings_instances_itsm:
    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
    data:
      ConnectionSettings:
        Auth_Password: string
        Auth_UserName: string
        Url: string
    description: string
    dypName: string
    instanceId: string
    name: string

- name: Delete by id
  cisco.dnac.integration_settings_instances_itsm:
    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
    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 DNAC Python SDK

Returned: always

Sample: {"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)