W3cubDocs

/Ansible 2.11

inspur.sm.edit_preserve_config – Set preserve 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_preserve_config.

New in version 0.1.0: of inspur.sm

Synopsis
Parameters
Examples
Return Values

Synopsis

Set preserve config on Inspur server.

Parameters

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.
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 setting=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.
setting string / required		Choices: all none manual	Preserve option, all - preserve all config; none - overwrite all config; manual - manual choose.
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: Preserve test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set preserve all"
    inspur.sm.edit_preserve_config:
      setting: "all"
      provider: "{{ ism }}"

  - name: "Set preserve none"
    edit_preserve_config:
      setting: "none"
      provider: "{{ ism }}"

  - name: "Set preserve manual"
    edit_preserve_config:
      setting: "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	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.

Authors

WangBaoshan (@ISIB-group)

© 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/inspur/sm/edit_preserve_config_module.html