On this page
ipadm_addrprop - Manage IP address properties on Solaris/illumos systems.
New in version 2.3.
Synopsis
- Modify IP address properties on Solaris/illumos systems.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
addrobj
required
|
Specifies the address object we want to manage.
aliases: nic, interface |
|
property
required
|
Specifies the name of the address property we want to manage.
aliases: name |
|
state |
|
Set or reset the property value.
|
temporary | Default:
"no"
|
Specifies that the address property value is temporary. Temporary values do not persist across reboots.
|
value |
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, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
addrobj
string
|
always |
address object name
Sample:
bge0/v4
|
property
string
|
always |
property name
Sample:
deprecated
|
state
string
|
always |
state of the target
Sample:
present
|
temporary
boolean
|
always |
specifies if operation will persist across reboots
Sample:
True
|
value
string
|
when value is provided |
property value
Sample:
26
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Adam Števko (@xen0l)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ipadm_addrprop_module.html