inspur.sm.edit_ipv4 – Set ipv4 information.

Note

This plugin is part of the inspur.sm collection (version 1.1.2).

To install it use: ansible-galaxy collection install inspur.sm.

To use it in a playbook, specify: inspur.sm.edit_ipv4.

New in version 0.1.0: of inspur.sm

Synopsis
Parameters
Examples
Return Values

Synopsis

Set ipv4 information on Inspur server.

Parameters

Parameter		Choices/Defaults	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		eth0 eth1 bond0	Set interface_name.
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		dhcp static	Enable 'Enable DHCP' to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP).
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 disable	Enable or disable IPV4.
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.

Examples

- name: Ipv4 test
  hosts: ism
  connection: local
  gather_facts: no
  vars:
    ism:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Set ipv4 information"
    inspur.sm.edit_ipv4:
      interface_name: "eth0"
      ipv4_status: "disable"
      provider: "{{ ism }}"

  - name: "Set ipv4 information"
    inspur.sm.edit_ipv4:
      interface_name: "eth0"
      ipv4_status: "enable"
      ipv4_dhcp_enable: "dhcp"
      provider: "{{ ism }}"

  - name: "Set ipv4 information"
    inspur.sm.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: "{{ 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/2.11/collections/inspur/sm/edit_ipv4_module.html