cisco.dnac.command_runner_run_command – Resource module for Command Runner Run Command

Note

This plugin is part of the cisco.dnac collection (version 3.2.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.command_runner_run_command.

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operation create of the resource Command Runner Run Command.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.1

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
commands list / elements=string		Command Runner Run Command's commands.
description string		Command Runner Run Command's description.
deviceUuids list / elements=string		Command Runner Run Command's deviceUuids.
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.2.3"	Informs the SDK which version of Cisco DNA Center to use.
name string		Command Runner Run Command's name.
timeout integer		Command Runner Run Command's timeout.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• Does not support check_mode

See Also

See also

Command Runner Run Command reference

Complete reference of the Command Runner Run Command object model.

Examples

- name: Create
  cisco.dnac.command_runner_run_command:
    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}}"
    commands:
    - string
    description: string
    deviceUuids:
    - string
    name: string
    timeout: 0

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": { "taskId": "string", "url": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)