ibmi_host_server_service – Manage host server

Synopsis

  • Manage and query IBM i host server service.

  • For non-IBM i targets, use the ansible.builtin.service module instead.

Parameters

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: false
type: str
become_user_password

Use this option to set the password of the user specified in become_user.

required: false
type: str
extra_parameters

Extra parameter is appended at the end of host server service command

required: false
type: str
default:
joblog

If set to true, append JOBLOG to stderr/stderr_lines.

required: false
type: bool
name_list

The name of the host server service. The valid value are *ALL, *CENTRAL, *DATABASE, *DTAQ, *FILE, *NETPRT, *RMTCMD, *SIGNON, *SVRMAP.

required: True
type: list
elements: str
state

started/stopped are idempotent actions that will not run commands unless necessary.

restarted will always bounce the service.

At least one of state and enabled are required.

required: True
type: str
choices: started, stopped

Examples

- name: start host server service
  ibm.power_ibmi.ibmi_host_server_service:
    name_list: ['*CENTRAL', '*DATABASE']
    state: 'started'
    joblog: True
    become_user: 'USER1'
    become_user_password: 'yourpassword'

See Also

See also

  • service_module

Return Values

job_log
The IBM i job log of the task executed.
returned: always
type: list
sample:
[{"FROM_INSTRUCTION": "318F", "FROM_LIBRARY": "QSYS", "FROM_MODULE": "", "FROM_PROCEDURE": "", "FROM_PROGRAM": "QWTCHGJB", "FROM_USER": "CHANGLE", "MESSAGE_FILE": "QCPFMSG", "MESSAGE_ID": "CPD0912", "MESSAGE_LIBRARY": "QSYS", "MESSAGE_SECOND_LEVEL_TEXT": "Cause . . . . . :   This message is used by application programs as a general escape message.", "MESSAGE_SUBTYPE": "", "MESSAGE_TEXT": "Printer device PRT01 not found.", "MESSAGE_TIMESTAMP": "2020-05-20-21.41.40.845897", "MESSAGE_TYPE": "DIAGNOSTIC", "ORDINAL_POSITION": "5", "SEVERITY": "20", "TO_INSTRUCTION": "9369", "TO_LIBRARY": "QSYS", "TO_MODULE": "QSQSRVR", "TO_PROCEDURE": "QSQSRVR", "TO_PROGRAM": "QSQSRVR"}]
start
The command execution start time.
returned: always
type: str
sample: 2019-12-02 11:07:53.757435
end
The command execution end time.
returned: always
type: str
sample: 2019-12-02 11:07:54.064969
delta
The command execution delta time.
returned: always
type: str
sample: 0:00:00.307534
stdout
The command standard output.
returned: always
type: str
sample: +++ success STRHOSTSVR SERVER(*ALL)
stderr
The command standard error.
returned: always
type: str
sample: CPF2111:Library TESTLIB already exists
cmd
The command executed by the task.
returned: always
type: str
sample: STRHOSTSVR SERVER(*ALL)
rc
The command return code (0 means success, non-zero means failure).
returned: always
type: int
sample: 255
stdout_lines
The command standard output split in lines.
returned: always
type: list
sample:
["+++ success STRHOSTSVR SERVER(*ALL)"]
stderr_lines
The command standard error split in lines.
returned: always
type: list
sample:
["CPF2111:Library TESTLIB already exists."]