kaytus.ksmanage.edit_ipv4 module – Set ipv4 information

Note

This module is part of the kaytus.ksmanage collection (version 2.0.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 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_ipv4.

New in kaytus.ksmanage 1.0.0

Synopsis

  • Set ipv4 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"

ipv4_address

string

If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface.

Required when ipv4_dhcp_enable=static.

ipv4_dhcp_enable

string

Enable ‘Enable DHCP’ to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP).

Choices:

  • "dhcp"

  • "static"

ipv4_gateway

string

If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface.

Required when ipv4_dhcp_enable=static.

ipv4_status

string

Enable or disable IPV4.

Choices:

  • "enable"

  • "disable"

ipv4_subnet

string

If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface.

Required when ipv4_dhcp_enable=static.

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: Ipv4 test
  hosts: ksmanage
  connection: local
  gather_facts: false
  vars:
    ksmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set ipv4 information"
    kaytus.ksmanage.edit_ipv4:
      interface_name: "eth0"
      ipv4_status: "disable"
      provider: "{{ ksmanage }}"

  - name: "Set ipv4 information"
    kaytus.ksmanage.edit_ipv4:
      interface_name: "eth0"
      ipv4_status: "enable"
      ipv4_dhcp_enable: "dhcp"
      provider: "{{ ksmanage }}"

  - name: "Set ipv4 information"
    kaytus.ksmanage.edit_ipv4:
      interface_name: "eth0"
      ipv4_status: "enable"
      ipv4_dhcp_enable: "static"
      ipv4_address: "100.2.36.10"
      ipv4_subnet: "255.255.255.0"
      ipv4_gateway: "100.2.36.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)