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

Note

This module is part of the community.network collection (version 5.0.2).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Reboot a HUAWEI CloudEngine switches.

Aliases: network.cloudengine.ce_reboot

Requirements

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

  • ncclient

Parameters

Parameter

Comments

confirm

boolean / required

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

Choices:

  • false

  • true

save_config

boolean

Flag indicating whether to save the configuration.

Choices:

  • false ← (default)

  • true

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: false
  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

Description

rebooted

boolean

Whether the device was instructed to reboot.

Returned: success

Sample: true

Authors

  • Gong Jianjun (@QijunPan)