New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
addrobj |
yes |
Specifies the address object we want to manage.
aliases: nic, interface
|
||
property |
yes |
Specifies the name of the address property we want to manage.
aliases: name
|
||
state |
no | present |
|
Set or reset the property value.
|
temporary |
no |
Specifies that the address property value is temporary. Temporary values do not persist across reboots.
|
||
value |
no |
Specifies the value we want to set for the address property.
|
name: Mark address on addrobj as deprecated ipadm_addrprop: property=deprecated value=on addrobj=e1000g0/v6 name: Set network prefix length for addrobj ipadm_addrprop: addrobj=bge0/v4 name=prefixlen value=26
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
state |
state of the target
|
always | string | present |
property |
property name
|
always | string | deprecated |
temporary |
specifies if operation will persist across reboots
|
always | boolean | True |
value |
property value
|
when value is provided | string | 26 |
addrobj |
address object name
|
always | string | bge0/v4 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.