Modules

Modules can be used from the command line or in a playbook task. Ansible executes each module, usually on the remote target node, and collects return values.

While different modules perform different tasks, their interfaces and responses follow similar patterns.

Module reference

Reference material for each module contains documentation on what parameters certain modules accept and what values they expect those parameters to be.

Contents:

• ibmi_at – Schedule a batch job
• ibmi_cl_command – Executes a CL(Control language) command
• ibmi_copy – Copy a save file from local to a remote IBM i node
• ibmi_device_vary – Vary on or off target device
• ibmi_display_fix – Displays the PTF(Program Temporary Fix) information and also get the requisite PTFs information of the PTF
• ibmi_display_subsystem – Displays all currently active subsystems or currently active jobs in a subsystem
• ibmi_download_fix – Download fix through SNDPTFORD
• ibmi_download_fix_status – Checking whether the fix downloading complete
• ibmi_end_subsystem – End an active subsystem.
• ibmi_ethernet_port – Retrieves all the ethernet ports(both virtual and physical)information on the system.
• ibmi_facts – Gathering ibmi facts
• ibmi_fetch – Fetch objects or a library from a remote IBM i node and store on local
• ibmi_fix – Install, remove or query an individual fix or a set of fixes on to IBM i system.
• ibmi_fix_check – Retrieve the latest PTF group information from PSP server.
• ibmi_fix_compare – Verify whether the PTFs are installed.
• ibmi_fix_group_check – Retrieve the latest PTF group information from PSP server.
• ibmi_fix_imgclg – Install fixes such as PTF, PTF Group, Technology refresh to the target IBM i system by image catalog.
• ibmi_fix_network_install_client – Install PTFs on the client via IBM i Network install
• ibmi_fix_network_install_server – Setup IBM i Network install server which contains image files of PTFs, PTF Group and Technology refresh.
• ibmi_fix_product_check – Check the software product installation status for a fix
• ibmi_fix_repo – Manipulate the PTF database via sqlite3
• ibmi_fix_repo_lv1 – Manipulate the PTF database via sqlite3
• ibmi_get_nonconfigure_disks – Get all un-configure disks
• ibmi_host_server_service – Manage host server
• ibmi_iasp – Control IASP
• ibmi_install_product_from_savf – Install the licensed program(product) from a save file.
• ibmi_job – Returns job information according to inputs.
• ibmi_lib_restore – Restore one library
• ibmi_lib_save – Save one libary
• ibmi_message – Search message
• ibmi_mirror_setup_copy – Configures the Db2 Mirror on the target node.
• ibmi_mirror_setup_source – Configures the Db2 Mirror on the source node
• ibmi_mirror_warm_clone_activity – Performs suspend and resume activity for warm clone.
• ibmi_module_authority_check – Check the authority of executing a module.
• ibmi_module_config – Configures managed nodes settings
• ibmi_nrg_link – Manages NRGs(Network Redundancy Groups) links
• ibmi_object_authority – Grant, revoke or display object authority
• ibmi_object_find – Find specific IBM i object(s).
• ibmi_object_restore – Restore one or more objects
• ibmi_object_save – Save one or more objects
• ibmi_query_job_log – Query the specific job log.
• ibmi_reboot – Reboot an IBM i machine
• ibmi_reply_message – Send a reply message to the sender of an inquiry message
• ibmi_rtv_command – Executes a command which is valid only within a CL program or REXX procedure
• ibmi_save_product_to_savf – Save the the licensed program(product) to a save file
• ibmi_script – Execute a local cl/sql script file.
• ibmi_script_execute – Execute a cl/sql script file
• ibmi_spooled_file_data – Returns the content of a spooled file.
• ibmi_sql_execute – Executes a SQL non-DQL(Data Query Language) statement
• ibmi_sql_query – Executes a SQL DQL(Data Query Language) statement.
• ibmi_sqlite3 – Executes a SQL statement via sqlite3
• ibmi_start_subsystem – Start an inactive subsystem
• ibmi_submit_job – Submit a job on IBM i system. This module functions like SBMJOB.
• ibmi_sync – Synchronize a save file from current IBM i node A to another IBM i node B.
• ibmi_sync_files – Synchronize a list of files from current IBM i node A to another IBM i node B.
• ibmi_synchronize – Synchronize a save file from IBM i node A to another IBM i node B
• ibmi_synchronize_files – Synchronize a list of files from IBM i node A to another IBM i node B
• ibmi_sysval – Displays the specified system value
• ibmi_tcp_interface – Add, change, remove or query a tcp/ip interface.
• ibmi_tcp_server_service – Manage tcp server
• ibmi_uninstall_product – Delete the objects that make up the licensed program(product)
• ibmi_user_and_group – Create, change or display a user(or group) profile
• ibmi_user_compliance_check – Check if the value of a field of user profile is expected