New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
interface |
yes | Specifies the IP interface we want to manage.
aliases: nic | ||
property |
yes | Specifies the name of the property we want to manage.
aliases: name | ||
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. |
name: Allow forwarding of IPv4 packets on network interface e1000g0 ipadm_ifprop: protocol=ipv4 property=forwarding value=on interface=e1000g0 name: Temporarily reset IPv4 forwarding property on network interface e1000g0 ipadm_ifprop: protocol=ipv4 interface=e1000g0 temporary=true property=forwarding state=reset name: Configure IPv6 metric on network interface e1000g0 ipadm_ifprop: protocol=ipv6 nic=e1000g0 name=metric value=100 name: Set IPv6 MTU on network interface bge0 ipadm_ifprop: interface=bge0 name=mtu value=1280 protocol=ipv6
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
interface | interface name we want to set property on | always | str | e1000g0 |
state | state of the target | always | string | present |
property | property's name | always | str | mtu |
protocol | property's protocol | always | str | ipv4 |
value | property's value | when value is provided | str | 1280 |
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.