community.network.ce_reboot – Reboot a HUAWEI CloudEngine switches.

From Get docs
Ansible/docs/2.11/collections/community/network/ce reboot module


community.network.ce_reboot – Reboot a HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

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


Synopsis

  • Reboot a HUAWEI CloudEngine switches.

Requirements

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

  • ncclient

Parameters

Parameter Choices/Defaults Comments

confirm

boolean / required

  • no
  • yes

Safeguard boolean. Set to true if you're sure you want to reboot.

save_config

boolean

  • no

  • yes

Flag indicating whether to save the configuration.



Notes

Note

  • This module requires the netconf system service be enabled on the remote device being managed.
  • Recommended connection is netconf.
  • This module also works with local connections for legacy playbooks.


Examples

- name: Reboot module test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:
  - name: Reboot the device
    community.network.ce_reboot:
      confirm: true
      save_config: true
      provider: "{{ cli }}"

Return Values

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

Key Returned Description

rebooted

boolean

success

Whether the device was instructed to reboot.


Sample:

True




Authors

  • Gong Jianjun (@QijunPan)

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