W3cubDocs

/Ansible

inspur.sm.edit_network_link – Set network link.

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_network_link.

New in version 0.1.0: of inspur.sm

Synopsis

  • Set network link on Inspur server.

Parameters

Parameter Choices/Defaults Comments
auto_nego
string
    Choices:
  • enable
  • disable
This option is enabled to allow the device to perform automatic configuration to
achieve the best possible mode of operation(speed and duplex) over a link.
duplex_mode
string
    Choices:
  • HALF
  • FULL
Select any one of the following Duplex Mode.
Required when auto_nego=disable.
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
string / required
    Choices:
  • shared
  • dedicated
  • both
Interface name.
link_speed
integer
    Choices:
  • 10
  • 100
Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps.
Required when auto_nego=disable.
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: link test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set network link"
    inspur.sm.edit_network_link:
      interface: "dedicated"
      auto_nego: "enable"
      provider: "{{ ism }}"

  - name: "Set network link"
    inspur.sm.edit_network_link:
      interface: "dedicated"
      auto_nego: "disable"
      link_speed: 100
      duplex_mode: "FULL"
      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_network_link_module.html