W3cubDocs

/Ansible

community.network.apconos_command – Run arbitrary commands on APCON devices

Note

This plugin is part of the community.network collection (version 3.0.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 community.network.

To use it in a playbook, specify: community.network.apconos_command.

New in version 0.2.0: of community.network

Synopsis
Parameters
Notes
Examples

Synopsis

Sends arbitrary commands to an apcon device and returns the results read from the device. The module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Parameters

Parameter	Choices/Defaults	Comments
commands list / elements=string / required		List of commands to send to the remote device over the configured provider. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
interval integer	Default: 1	Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again.
match string	Choices: any all ←	The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are `all` or `any`. If the value is set to `all` then all conditionals in the wait_for must be satisfied. If the value is set to `any` then only one of the values must be satisfied.
retries integer	Default: 10	Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions.
wait_for list / elements=string		List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples.

Notes

Note

Tested against apcon iis+ii

Examples

- name: Basic Configuration
  community.network.apconos_command:
    commands:
    - show version
    - enable ssh
  register: result

- name: Get output from single command
  community.network.apconos_command:
    commands: ['show version']
  register: result

Authors

David Lee (@davidlee-ap)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/apconos_command_module.html