ipadm_addrprop - Manage IP address properties on Solaris/illumos systems.
New in version 2.3.
Synopsis
- Modify IP address properties on Solaris/illumos systems.
Options
| 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.
|
Examples
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
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| addrobj |
address object name
|
always | string | bge0/v4 |
| property |
property name
|
always | string | deprecated |
| state |
state of the target
|
always | string | present |
| temporary |
specifies if operation will persist across reboots
|
always | boolean | True |
| value |
property value
|
when value is provided | string | 26 |
Status
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ipadm_addrprop_module.html