You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.

kaytus.ksmanage.edit_network_link module – Set network link

Note

This module is part of the kaytus.ksmanage collection (version 1.2.2).

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 kaytus.ksmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kaytus.ksmanage.edit_network_link.

New in kaytus.ksmanage 1.0.0

Synopsis

• Set network link on kaytus Server.

Requirements

The below requirements are needed on the host that executes this module.

• Python 3.7+

• inManage

Parameters

Parameter	Comments
auto_nego string	This option allows the device to perform auto-configuration. To achieve the best mode of operation (speed and duplex) on the link. Choices: "enable" "disable"
duplex_mode string	Select any one of the following Duplex Mode. Required when auto_nego=disable. Choices: "HALF" "FULL"
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	Interface name. Choices: "shared" "dedicated" "both"
link_speed integer	Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps. Required when auto_nego=disable. Choices: 10 100
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.

Notes

Note

• Does not support check_mode.

Examples

- name: Link test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set network link"
    kaytus.ksmanage.edit_network_link:
      interface: "dedicated"
      auto_nego: "enable"
      provider: "{{ ksmanage }}"

  - name: "Set network link"
    kaytus.ksmanage.edit_network_link:
      interface: "dedicated"
      auto_nego: "disable"
      link_speed: 100
      duplex_mode: "FULL"
      provider: "{{ ksmanage }}"

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 (@ieisystem)

Collection links

• Issue Tracker
• Repository (Sources)