Documentation

ipadm_prop - Manage protocol properties on Solaris/illumos systems.

New in version 2.2.

Synopsis

  • Modify protocol properties on Solaris/illumos systems.

Options

parameter required default choices comments
property
yes
Specifies the name of property we want to manage.
protocol
yes
Specifies the procotol for which we want to manage properties.
state
no present
  • present
  • absent
  • reset
Set or reset the property value.
temporary
no
  • true
  • false
Specifies that the property value is temporary. Temporary property values do not persist across reboots.
value
no
Specifies the value we want to set for the property.

Examples

# Set TCP receive buffer size
ipadm_prop: protocol=tcp property=recv_buf value=65536

# Reset UDP send buffer size to the default value
ipadm_prop: protocol=udp property=send_buf state=reset

Return Values

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

name description returned type sample
protocol
property's protocol
always string TCP
state
state of the target
always string present
property
name of the property
always string recv_maxbuf
temporary
property's persistence
always boolean True
value
value of the property. May be int or string depending on property.
always int '1024' or 'never'


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.