community.network.ipadm_addrprop module – Manage IP address properties on Solaris/illumos systems.

Note

This module is part of the community.network collection (version 3.3.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.

Synopsis

  • Modify IP address properties on Solaris/illumos systems.

Parameters

Parameter

Comments

addrobj

aliases: nic, interface

string / required

Specifies the address object we want to manage.

property

aliases: name

string / required

Specifies the name of the address property we want to manage.

state

string

Set or reset the property value.

Choices:

  • present ← (default)

  • absent

  • reset

temporary

boolean

Specifies that the address property value is temporary. Temporary values do not persist across reboots.

Choices:

  • no ← (default)

  • yes

value

string

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

addrobj

string

address object name

Returned: always

Sample: “bge0/v4”

property

string

property name

Returned: always

Sample: “deprecated”

state

string

state of the target

Returned: always

Sample: “present”

temporary

boolean

specifies if operation will persist across reboots

Returned: always

Sample: true

value

string

property value

Returned: when value is provided

Sample: 26

Authors

  • Adam Števko (@xen0l)