Note
This plugin is part of the community.network collection (version 3.0.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_addrprop.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| addrobj string / required | Specifies the address object we want to manage. aliases: nic, interface | |
| property string / required | Specifies the name of the address property we want to manage. aliases: name | |
| state string |
| Set or reset the property value. |
| temporary boolean |
| Specifies that the address property value is temporary. Temporary values do not persist across reboots. |
| value string | Specifies the value we want to set for the address property. |
- 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
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ipadm_addrprop_module.html