New in version 2.2.
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 |
|
Set or reset the property value. |
temporary |
no |
|
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. |
# 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
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 | always | int/string (depends on property) | '1024' or 'never' |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.