cisco.dnac.network_device_poller_read_request – Manage NetworkDevicePollerReadRequest objects of CommandRunner

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Submit request for read-only CLIs.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
commands list / elements=string / required		CommandRunnerDTO's commands (list of strings).
description string		CommandRunnerDTO's description.
deviceUuids list / elements=string / required		CommandRunnerDTO's deviceUuids (list of strings).
name string		CommandRunnerDTO's name.
timeout integer		CommandRunnerDTO's timeout.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.network_device_poller_read_request

The official documentation on the cisco.dnac.plugins.module_utils.definitions.network_device_poller_read_request module.

NetworkDevicePollerReadRequest reference

Complete reference of the NetworkDevicePollerReadRequest object model.

NetworkDevicePollerReadRequest reference

SDK reference.

Examples

- name: run_read_only_commands_on_devices
  cisco.dnac.network_device_poller_read_request:
    state: create  # required
    commands:  # required
    - SomeValue  # string
    deviceUuids:  # required
    - SomeValue  # string
    description: SomeValue  # string
    name: SomeValue  # string
    timeout: 1  #  integer

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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: command_runner.run_read_only_commands_on_devices

Authors

• Rafael Campos (@racampos)