ibmi_tcp_interface – Add, change, remove or query a tcp/ip interface.
Synopsis
The
ibmi_tcp_interfacemodule add, change, remove, start, end or query a tcp/ip interface.This module provides the similar function of ADDTCPIFC, CHGTCPIFC, RMVTCPIFC, STRTCPIFC, ENDTCPIFC.
In addition, the module provides query function for a specific internet address basing on internet address
or alias_name.
Parameters
- alias_name
A name that can be used in place of the internet address.
This alias_name can be used to change, remove, start, end and query a internet interface.
required: Falsetype: str- associated_local_interface
Use this parameter to associate the IPv4 interface being added with an existing local IPv4 TCP/IP interface.
required: Falsetype: str- auto_start
Specifies whether the interface is automatically started
when the TCP/IP stack is activated by the Start TCP/IP (STRTCP) command.
required: Falsetype: strchoices: *YES, *NO- become_user
The name of the user profile that the IBM i task will run under.
Use this option to set a user with desired privileges to run the task.
required: falsetype: str- become_user_password
Use this option to set the password of the user specified in
become_user.required: falsetype: str- extra_params
The extra parameters that the user wants to pass into this module.
These are the additional CL parameters that the user wants to pass to execute the CL commands.
required: Falsetype: str- internet_address
The internet address that will be added, changed, removed or queried.
The internet address may be an IPv4 or IPv6 address.
An interface is associated with a line description.
required: Falsetype: str- joblog
The job log of the job executing the task will be returned even rc is zero if it is set to True.
required: falsetype: bool- line_description
the name of the line description associated with the new interface.
The line description must exist before the TCP/IP interface can be added.
required: Falsetype: str- max_transmission_unit
Specifies the maximum size (in bytes) of IP datagrams that can be transmitted through this interface.
required: Falsetype: str- preferred_interface
A list of preferred IPv4 interfaces that are to be used with the IPv4 interface being added for proxy
Address Resolution Protocol (ARP) agent selection.
required: Falsetype: listelements: str- sec_to_wait
The number of seconds that the module waits after executing the task
before returning the information of the internet address.
Some tasks such as start and end the interface will need to wait some seconds
before it can return the final status.
If default zero is used, the returned information could be the intermediate status of
starting or ending the interface.
required: falsetype: int- state
The state of the interface.
present means to add, change or query the internet interface.
When the internet address does not exist on the IBM i system, present option will create the interface.
When the internet address exists on the IBM i system, and only internet_address or alias_name is specified, present option will query the specific interface.
When the internet address exists on the IBM i system, and internet_address option is used together with other options, present option will change the specific interface.
absent means to remove the internet interface. Either internet_address or alias_name can be used.
If both internet_address and alias_name are used for absent option, the alias_name option will be ignored.
active means to start the internet interface. Either internet_address or alias_name can be used.
If both internet_address and alias_name are used for absent option, the alias_name option will be ignored.
inactive means to end the internet interface. Either internet_address or alias_name can be used.
If both internet_address and alias_name are used for absent option, the alias_name option will be ignored.
required: falsetype: strdefault: presentchoices: present, absent, inactive, active- subnet_mask
Defines the subnet mask
which is a bit mask that defines the part of the network where this IPv4 interface attaches.
required: Falsetype: str- text_description
Specifies text that briefly describes the interface.
required: Falsetype: str- type_of_service
The type of service specifies how the internet hosts and routers should make trade-offs
between throughput, delay, reliability, and cost.
required: Falsetype: strchoices: *NORMAL, *MINDELAY, *MAXTHRPUT, *MAXRLB, *MINCOST- vlan_id
The virtual LAN identifier of the associated line.
This identifies the virtual LAN to which this interface belongs according to IEEE standard 802.1Q.
This parameter is only valid for interfaces defined for Ethernet adapters that support the 802.1Q standard.
This must be used together with line_description.
required: Falsetype: str
Examples
- name: create an interface 1
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.11'
subnet_mask: '255.255.255.0'
line_description: 'LIND1'
sec_to_wait: 5
state: 'present'
- name: create an interface 2
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.12'
line_description: 'LIND1'
subnet_mask: '255.255.255.0'
state: 'present'
alias_name: 'alias'
- name: create an interface 3
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.13'
line_description: 'LIND1'
subnet_mask: '255.255.255.0'
preferred_interface:
- "9.5.155.12"
state: 'present'
alias_name: 'alias13'
- name: create an interface 4
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.14'
line_description: 'LIND1'
subnet_mask: '255.255.255.0'
preferred_interface:
- "9.5.155.12"
- "9.5.155.13"
state: 'present'
alias_name: 'alias14'
- name: create an interface 5
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.15'
line_description: 'LIND1'
vlan_id: '2'
subnet_mask: '255.255.255.0'
preferred_interface:
- "9.5.155.12"
- "9.5.155.13"
state: 'present'
alias_name: 'alias15'
- name: change an interface 1
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.11'
subnet_mask: '255.255.0.0'
state: 'present'
- name: change an interface 2
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.12'
subnet_mask: '255.255.0.0'
state: 'present'
alias_name: 'alias2'
- name: change an interface 3
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.11'
preferred_interface:
- "9.5.155.12"
- "9.5.155.13"
state: 'present'
- name: change an interface 4
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.12'
state: 'present'
alias_name: 'alias2'
- name: query an interface by ip
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.12'
state: 'present'
- name: query an interface by alias name
ibm.power_ibmi.ibmi_tcp_interface:
alias_name: 'alias14'
state: 'present'
- name: remove an interface by ip
ibm.power_ibmi.ibmi_tcp_interface:
internet_address: '9.5.155.11'
state: 'absent'
- name: remove an interface by alias name
ibm.power_ibmi.ibmi_tcp_interface:
alias_name: 'alias2'
state: 'absent'
Notes
Note
Ansible hosts file need to specify ansible_python_interpreter=/QOpenSys/pkgs/bin/python3(or python2)
Return Values
- start
- end
- delta
- stdout
- stderr
- rc
- stdout_lines
- stderr_lines
- job_log
- cl_command
- interface_info