community / community.network / 5.0.2 / module / ce_command Run arbitrary command on HUAWEI CloudEngine devices. Authors: JackyGao2016 (@CloudEngine-Ansible)community.network.ce_command (5.0.2) — module
Install with ansible-galaxy collection install community.network:==5.0.2
collections: - name: community.network version: 5.0.2
Sends an arbitrary command to an HUAWEI CloudEngine node and returns the results read from the device. The ce_command 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.
# Note: examples below use the following provider dict to handle # transport and authentication to the node. - name: CloudEngine command test hosts: cloudengine connection: local gather_facts: false vars: cli: host: "{{ inventory_hostname }}" port: "{{ ansible_ssh_port }}" username: "{{ username }}" password: "{{ password }}" transport: cli tasks: - name: "Run display version on remote devices" community.network.ce_command: commands: display version provider: "{{ cli }}" - name: "Run display version and check to see if output contains HUAWEI" community.network.ce_command: commands: display version wait_for: result[0] contains HUAWEI provider: "{{ cli }}" - name: "Run multiple commands on remote nodes" community.network.ce_command: commands: - display version - display device provider: "{{ cli }}" - name: "Run multiple commands and evaluate the output" community.network.ce_command: commands: - display version - display device wait_for: - result[0] contains HUAWEI - result[1] contains Device provider: "{{ cli }}"
match: default: all description: - The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the I(wait_for) must be satisfied. If the value is set to C(any) then only one of the values must be satisfied. retries: default: 10 description: - 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 I(wait_for) conditionals. commands: description: - The commands to send to the remote HUAWEI CloudEngine device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of I(retries) has been exceeded. required: true interval: default: 1 description: - Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. wait_for: description: - Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
failed_conditions: description: the conditionals that failed returned: failed sample: - '...' - '...' type: list stdout: description: the set of responses from the commands returned: always sample: - '...' - '...' type: list stdout_lines: description: The value of stdout split into a list returned: always sample: - - '...' - '...' - - '...' - - '...' type: list