cp_gaia_vlan_interface.¶
Synopsis¶
Modify vlan interface.
Parameters¶
- version (False, str, None)
Gaia API version for example 1.6.
- state (False, str, present)
Ansible state which can be
presentorabsent.- name (True, str, None)
Interface name with format “<parent interface>.<id>”, for example eth0.2, eth1.3 .. etc.
- ipv4_address (False, str, None)
Interface IPv4 address.
- ipv4_mask_length (False, int, None)
Interface IPv4 address mask length.
- ipv6_address (False, str, None)
Interface IPv6 address.
- ipv6_autoconfig (False, bool, None)
Configure IPv6 auto-configuration.
- ipv6_mask_length (False, int, None)
Interface IPv6 address mask length.
- comments (False, str, None)
Interface Comments.
- enabled (False, bool, None)
Interface State.
- dhcp (False, dict, None)
DHCP configuration.
- enabled (False, bool, None)
Enable DHCP on this interface.
- server_timeout (False, int, 60)
Specifies the amount of time, in seconds, that must pass between the time that the interface begins to try to determine its address and the time that it decides that it’s not going to be able to contact a server.
- retry (False, int, 300)
Specifies the time, in seconds, that must pass after the interface has determined that there is no DHCP server present before it tries again to contact a DHCP server.
- leasetime (False, int, None)
Specifies the lease time, in seconds, when requesting for an IP address. Default value is “default” - according to the server.
- reacquire_timeout (False, int, 10)
When trying to reacquire the last ip address, The reacquire-timeout statement sets the time, in seconds, that must elapse after the first try to reacquire the old address before it gives up and tries to discover a new address.
- mtu (False, int, None)
Interface mtu.
Notes¶
Note
Supports
check_mode.
Examples¶
- name: Set comment field of a vlan interface
check_point.gaia.cp_gaia_vlan_interface:
comments: "vlan5 interface"
name: eth1.5
Return Values¶
- vlan_interface (always., dict, )
The updated interface details.