ibmi_object_find – Find specific IBM i object(s).

Synopsis

  • Return a list of IBM i objects based on specific criteria. Multiple criteria are AND’d together.

Parameters

age

Select objects whose age is equal to or greater than the specified time. Use a negative age to find objects equal to or less than the specified time. You can choose seconds, minutes, hours, days, or weeks by specifying the first letter of any of those \n words (e.g., “1w”).

required: False
type: str
age_stamp

Choose the object statistic against which we compare age. Default is ctime which is the object creation time.

required: False
type: str
default: ctime
choices: ctime
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
iasp_name

The auxiliary storage pool (ASP) where storage is allocated for the object.

The default value is *SYSBAS.

If an IASP name is specified, objects in this ASP group will be returned, including both SYSBAS and IASP.

required: false
type: str
default: *SYSBAS
joblog

The job log of the job executing the task will be returned even rc is zero if it is set to true.

required: false
type: bool
lib_name

The name of the library that returned objects locate in

required: False
type: str
default: *ALLUSR
object_name

The name of the object that will be returned. Whether regex can be used for object_name is controlled by use_regex option

required: false
type: str
default: *ALL
object_type_list

One or more system object types separated by either a blank or a comma.

required: False
type: str
default: *ALL
size

Select objects whose size is equal to or greater than the specified size. Use a negative size to find objects equal to or less than the specified size. Unqualified values are in bytes but b, k, m, g, and t can be appended to specify bytes, kilobytes, megabytes, gigabytes, and terabytes, respectively.

required: False
type: str
use_regex

Controls whether regex can be used for object_name option. The target IBM i system needs to have the International Components for Unicode (ICU) option installed. It takes time to return result if this option is turned on.

required: false
type: bool

Examples

- name:  Find all journals and journal receivers in library WYTEST.
  ibm.power_ibmi.ibmi_object_find:
    object_name: '*ALL'
    object_type_list: '*JRN *JRNRCV'
    lib_name: 'WYTEST'
    age: '1w'
    age_stamp: 'ctime'

- name:  Find all the object names that contains 'ABC' with regex.
  ibm.power_ibmi.ibmi_object_find:
    object_name: 'ABC+'
    object_type_list: '*ALL'
    lib_name: '*ALL'
    use_regex: true

- name: find library WYTEST in sysbas
  ibm.power_ibmi.ibmi_object_find:
    lib_name: 'QSYS'
    iasp_name: '*SYSBAS'
    object_name: 'WYTEST'
    object_type_list: "*LIB"

- name: find object OBJABC in asp group WYTEST2
  ibm.power_ibmi.ibmi_object_find:
    lib_name: '*ALL'
    iasp_name: 'WYTEST2'
    object_type_list: "*FILE"
    object_name: 'OBJABC'
    become_user: 'USER1'
    become_user_password: 'yourpassword'

Notes

Note

Hosts file needs to specify ansible_python_interpreter=/QOpenSys/pkgs/bin/python3(or python2)

See Also

See also

  • find_module

Return Values

start
The task execution start time
returned: always
type: str
sample: 2019-12-02 11:07:53.757435
end
The task execution end time
returned: always
type: str
sample: 2019-12-02 11:07:54.064969
delta
The task execution delta time
returned: always
type: str
sample: 0:00:00.307534
object_list
The object list returned
returned: when rc as 0(success)
type: list
sample:
[{"IASP_NUMBER": 0, "LAST_RESET_TIMESTAMP": null, "LAST_USED_TIMESTAMP": null, "OBJATTRIBUTE": "SAVF", "OBJCREATED": "2019-02-18T10:48:41", "OBJDEFINER": "USERADMIN", "OBJLIB": "TESTLIB", "OBJNAME": "TESTOBJ1", "OBJOWNER": "WY", "OBJSIZE": 131072, "OBJTYPE": "*FILE", "TEXT": "TEST"}, {"IASP_NUMBER": 0, "LAST_RESET_TIMESTAMP": null, "LAST_USED_TIMESTAMP": null, "OBJATTRIBUTE": "SAVF", "OBJCREATED": "2019-02-18T10:48:41", "OBJDEFINER": "USERAPP", "OBJLIB": "TESTLIB", "OBJNAME": "RING1", "OBJOWNER": "WY", "OBJSIZE": 131072, "OBJTYPE": "*FILE", "TEXT": "test"}]
stdout
The task execution standard output
returned: When rc as non-zero(failure)
type: str
stderr
The task execution standard error
returned: When rc as non-zero(failure)
type: str
rc
The task execution return code (0 means success)
returned: always
type: int
stdout_lines
The task execution standard output split in lines
returned: When rc as non-zero(failure)
type: list
sample:
[""]
stderr_lines
The task execution standard error split in lines
returned: When rc as non-zero(failure)
type: list
sample:
[""]
job_log
The job log of the job executes the task.
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"}]