- Docs »
- inspur.sm.edit_restore_factory_default – Set preserver config.
-
You are reading the latest community version of the Ansible documentation. Red Hat subscribers, select 2.9 in the version selection to the left for the most recent Red Hat release.
inspur.sm.edit_restore_factory_default – Set preserver config.
Note
This plugin is part of the inspur.sm collection (version 1.1.2).
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 version 0.1.0: of inspur.sm
Parameter |
Choices/Defaults |
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.
|
override
list
/ elements=string
|
Choices:
- authentication
- dcmi
- fru
- hostname
- ipmi
- kvm
- network
- ntp
- pef
- sdr
- sel
- smtp
- snmp
- sol
- ssh
- syslog
- user
|
Configuration items that need to be retained.
Required when mode=manual.
|
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.
|
- 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 }}"
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
changed
boolean
|
always |
Check to see if a change was made on the device.
|
message
string
|
always |
Messages returned after module execution.
|
state
string
|
always |
Status after module execution.
|