community.network.ipadm_prop – Manage protocol properties on Solaris/illumos systems.

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_prop.

Synopsis

  • Modify protocol properties on Solaris/illumos systems.

Parameters

Parameter Choices/Defaults Comments
property
string / required
Specifies the name of property we want to manage.
protocol
string / required
Specifies the protocol for which we want to manage properties.
state
string
    Choices:
  • present ←
  • absent
  • reset
Set or reset the property value.
temporary
boolean
    Choices:
  • no ←
  • yes
Specifies that the property value is temporary. Temporary property values do not persist across reboots.
value
string
Specifies the value we want to set for the property.

Examples

- name: Set TCP receive buffer size
  community.network.ipadm_prop:
    protocol: tcp
    property: recv_buf
    value: 65536

- name: Reset UDP send buffer size to the default value
  community.network.ipadm_prop:
    protocol: udp
    property: send_buf
    state: reset

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
property
string
always
name of the property

Sample:
recv_maxbuf
protocol
string
always
property's protocol

Sample:
TCP
state
string
always
state of the target

Sample:
present
temporary
boolean
always
property's persistence

Sample:
True
value
integer
always
value of the property. May be int or string depending on property.

Sample:
'1024' or 'never'


Authors

  • Adam Števko (@xen0l)