inspur.sm.edit_restore_factory_default module – Set preserver config.

Note

This module is part of the inspur.sm collection (version 2.3.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 inspur.sm.

To use it in a playbook, specify: inspur.sm.edit_restore_factory_default.

New in inspur.sm 0.1.0

Synopsis

  • Set preserver config on Inspur server.

Parameters

Parameter

Comments

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

mode

string / required

Restore factory defaults mode.

Choices:

  • "all"

  • "none"

  • "manual"

override

list / elements=string

Configuration items that need to be retained.

Required when mode=manual.

Choices:

  • "authentication"

  • "dcmi"

  • "fru"

  • "hostname"

  • "ipmi"

  • "kvm"

  • "network"

  • "ntp"

  • "pef"

  • "sdr"

  • "sel"

  • "smtp"

  • "snmp"

  • "sol"

  • "ssh"

  • "syslog"

  • "user"

password

string

Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

provider

dictionary

A dict object containing connection details.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

username

string

Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

username

string

Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Examples

- name: Restore default test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set restore default auto"
    inspur.sm.edit_restore_factory_default:
      mode: "all"
      provider: "{{ ism }}"

  - name: "Set restore default manual"
    inspur.sm.edit_restore_factory_default:
      mode: "manual"
      override:
        - fru
        - ntp
        - network
        - user
      provider: "{{ ism }}"

Return Values

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

Key

Description

changed

boolean

Check to see if a change was made on the device.

Returned: always

message

string

Messages returned after module execution.

Returned: always

state

string

Status after module execution.

Returned: always

Authors

  • WangBaoshan (@ISIB-group)