community.network.ipadm_addrprop module – Manage IP address properties on Solaris/illumos systems.
Note
This module is part of the community.network collection (version 5.0.3).
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_addrprop
.
Synopsis
Modify IP address properties on Solaris/illumos systems.
Aliases: network.illumos.ipadm_addrprop
Parameters
Parameter |
Comments |
---|---|
Specifies the address object we want to manage. |
|
Specifies the name of the address property we want to manage. |
|
Set or reset the property value. Choices:
|
|
Specifies that the address property value is temporary. Temporary values do not persist across reboots. Choices:
|
|
Specifies the value we want to set for the address property. |
Examples
- name: Mark address on addrobj as deprecated
community.network.ipadm_addrprop: property=deprecated value=on addrobj=e1000g0/v6
- name: Set network prefix length for addrobj
community.network.ipadm_addrprop: addrobj=bge0/v4 name=prefixlen value=26
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
address object name Returned: always Sample: |
|
property name Returned: always Sample: |
|
state of the target Returned: always Sample: |
|
specifies if operation will persist across reboots Returned: always Sample: |
|
property value Returned: when value is provided Sample: |