cisco.catalystcenter.network_device_custom_prompt_info_info module -- Information module for Network Device Custom Prompt Info Info

Note

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

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

New in cisco.catalystcenter 6.0.0

Synopsis

• This module represents an alias of the module network_device_custom_prompt_info_info

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_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 string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_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 string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
headers dictionary	Additional headers.
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.custom_prompt_support_get_api,

• Paths used are get /dna/intent/api/v1/network-device/custom-prompt,

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

• 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 System Settings CustomPromptSupportGETAPIV1

Complete reference of the CustomPromptSupportGETAPIV1 API.

Examples

- name: Get all Network Device Custom Prompt Info Info
  cisco.catalystcenter.network_device_custom_prompt_info_info:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    verify: "{{ verify }}"
    api_port: "{{ api_port }}"
    version: "{{ version }}"
    debug: "{{ debug }}"
    headers: "{{my_headers | from_json}}"
  register: result

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:`{"response": {"customPasswordPrompt": "string", "customUsernamePrompt": "string", "defaultPasswordPrompt": "string", "defaultUsernamePrompt": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)