cisco.catalystcenter.integration_settings_itsm_instances_info module -- Information module for Integration Settings Itsm Instances

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

New in cisco.catalystcenter 6.14.0

Synopsis

  • Get all Integration Settings Itsm Instances.

  • Fetches all ITSM Integration settings.

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:

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:

catc_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

headers

dictionary

Additional headers.

order

string

Order query parameter. Specify the sorting order - asc for ascending or desc for descending.

page

float

Page query parameter. Indicates the current page number to display.

page_size

float

Page_size query parameter. Specifies the number of records to display per page.

sortBy

string

SortBy query parameter. The field name used to sort the records.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are itsm_integration.ItsmIntegration.get_all_itsm_integration_settings,

  • Paths used are get /dna/intent/api/v1/integration-settings/itsm/instances,

  • Supports 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 GetAllITSMIntegrationSettings

Complete reference of the GetAllITSMIntegrationSettings API.

Examples

---
- name: Get all Integration Settings Itsm Instances
  cisco.catalystcenter.integration_settings_itsm_instances_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    page_size: 0
    page: 0
    sortBy: string
    order: string
  register: result

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:`{"data": [{"\_id": "string", "createdBy": "string", "description": "string", "dypId": "string", "dypMajorVersion": 0, "dypName": "string", "id": "string", "name": "string", "schemaVersion": 0, "softwareVersionLog": [{}], "uniqueKey": "string", "updatedBy": "string", "updatedDate": 0}], "page": 0, "pageSize": 0, "totalPages": 0, "totalRecords": 0}`

Authors

  • Rafael Campos (@racampos)