community.network.ipadm_addr module – Manage IP addresses on an interface on Solaris/illumos systems
Note
This module is part of the community.network collection (version 5.1.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 community.network
.
To use it in a playbook, specify: community.network.ipadm_addr
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
Create/delete static/dynamic IP addresses on network interfaces on Solaris/illumos systems.
Up/down static/dynamic IP addresses on network interfaces on Solaris/illumos systems.
Manage IPv6 link-local addresses on network interfaces on Solaris/illumos systems.
Aliases: network.illumos.ipadm_addr
Parameters
Parameter |
Comments |
---|---|
Specifiies an IP address to configure in CIDR notation. |
|
Specifies an unique IP address on the system. |
|
Specifiies a type of IP address to configure. Choices:
|
|
Create/delete/enable/disable an IP address on the network interface. Choices:
|
|
Specifies that the configured IP address is temporary. Temporary IP addresses do not persist across reboots. Choices:
|
|
Specifies the time in seconds we wait for obtaining address via DHCP. Default: |
Examples
- name: Configure IP address 10.0.0.1 on e1000g0
community.network.ipadm_addr: addr=10.0.0.1/32 addrobj=e1000g0/v4 state=present
- name: Delete addrobj
community.network.ipadm_addr: addrobj=e1000g0/v4 state=absent
- name: Configure link-local IPv6 address
community.network.ipadm_addr: addtype=addrconf addrobj=vnic0/v6
- name: Configure address via DHCP and wait 180 seconds for address obtaining
community.network.ipadm_addr: addrobj=vnic0/dhcp addrtype=dhcp wait=180
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
IP address Returned: only if addrtype is ‘static’ Sample: |
|
address object name Returned: always Sample: |
|
address type Returned: always Sample: |
|
state of the target Returned: always Sample: |
|
specifies if operation will persist across reboots Returned: always Sample: |
|
time we wait for DHCP Returned: only if addrtype is ‘dhcp’ Sample: |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.