Docs4dev
Docs
ansible / latest / collections / inspur / sm / edit_ncsi_module.html

inspur.sm.edit_ncsi – Set ncsi information.

Note

This plugin is part of the inspur.sm collection (version 1.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_ncsi.

New in version 0.1.0: of inspur.sm

Synopsis

  • Set ncsi information on Inspur server.

Parameters

Parameter Choices/Defaults Comments
channel_number
integer
Channel number, like 0,1,2...
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.
interface_name
string
Interface name, for example eth0.
mode
string
    Choices:
  • auto
  • manual
NCSI mode, auto-Auto Failover, manual-Manual Switch.
nic_type
string
    Choices:
  • PHY
  • OCP
  • PCIE
  • auto
Nic type.
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: NCSI test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set ncsi information"
    inspur.sm.edit_ncsi:
      mode: "manual"
      nic_type: "PCIE"
      interface_name: "eth0"
      channel_number: 1
      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/latest/collections/inspur/sm/edit_ncsi_module.html