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

Note

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

Note

The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.

DEPRECATED

Removed in:

version 6.0.0

Why:

This collection and all content in it is unmaintained and deprecated.

Alternative:

Unknown.

Synopsis

  • Modify protocol properties on Solaris/illumos systems.

Aliases: network.illumos.ipadm_prop

Parameters

Parameter

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

Set or reset the property value.

Choices:

  • "present" ← (default)

  • "absent"

  • "reset"

temporary

boolean

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

Choices:

  • false ← (default)

  • true

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

Description

property

string

name of the property

Returned: always

Sample: "recv_maxbuf"

protocol

string

property’s protocol

Returned: always

Sample: "TCP"

state

string

state of the target

Returned: always

Sample: "present"

temporary

boolean

property’s persistence

Returned: always

Sample: true

value

integer

value of the property. May be int or string depending on property.

Returned: always

Sample: "'1024' or 'never'"

Status

  • This module will be removed in version 6.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Adam Števko (@xen0l)