kaytus.ksmanage.edit_vlan module – Set vlan information

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

New in kaytus.ksmanage 1.0.0

Synopsis 

Set vlan information on kaytus Server.

Requirements 

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

Python 3.7+
inManage

Parameters 

Parameter	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.
interface_name string / required	Set interface name. Select the LAN interface to be configured. Choices: `"eth0"` `"eth1"` `"bond0"`
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.
vlan_id integer	The Identification for VLAN configuration(2-4094).
vlan_priority integer	The priority for VLAN configuration(1-7).
vlan_status string	Enable or disable vlan. Choices: `"enable"` `"disable"`

Notes 

Note

Does not support check_mode.

Examples 

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

  tasks:

  - name: "Set vlan information"
    kaytus.ksmanage.edit_vlan:
      interface_name: "eth0"
      vlan_status: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set vlan information"
    kaytus.ksmanage.edit_vlan:
      interface_name: "eth0"
      vlan_status: "enable"
      vlan_id: 2
      vlan_priority: 1
      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)

kaytus.ksmanage.edit_vlan module – Set vlan information

Synopsis

Requirements

Parameters

Notes

Examples

Return Values