ibmi_download_fix_from_cloud – Download fix using the cloud API to Electronic Fix Delivery (EFD).
Synopsis
The
ibmi_download_fix_from_cloudmodule downloads fixes using a cloud API to Electronic Fix Delivery (EFD). This allows fixes to be downloaded to a Linux server for those environments where it is not possible to download to an IBM i server, e.g., due to network restrictions. Users should continue to use module ibmi_download_fix (based on the SNDPTFORD CL command) for downloading fixes to an IBM i server.Only individual PTFs can be downloaded due to current cloud API limitations.
Individual PTFs are only provided in save files due to current cloud API limitations.
The downloaded save files and cover letters will have sym links created in the download directory to follow naming protocols for these files on the IBM i server in the QGPL library. The PTF file link is “Q<ptf_id>.FILE” and the cover letter file link is “Q<pfd_id>.MBR”.
Future support will include virtual images for PTFS, PTF groups, and cumulative PTF packages.
Parameters
- clean_directory
Clean out contents of specified directory prior to download.
required: Falsetype: bool- credentials
Machine credentials used to validate entitlement for the requested fix.
Includes fields for ‘machine_model’, ‘machine_type’, ‘serial_number’, and ‘country’. This information can be determined from the ibmi_facts module output.
required: Truetype: dict- directory
Directory to download the fix files to. The directory is created if it does not already exist. The full or absolute directory path must be specified.
required: Truetype: str- include_requisites
Specifies if requisite PTFs should be included with the ordered PTFs.
required: Falsetype: bool- operation
The various operations include
Download the fix (includes validating fix entitlement based on the provided credentials).
Validate machine entitlement for the fix based on credentials provided. No download occurs.
Preview the fix. Useful for viewing the pre/co-requisite fixes. No download occurs.
required: Falsetype: strdefault: downloadchoices: download, validate, preview- ptf_id
Specify the identifier of the PTF information being ordered.
required: Truetype: str- time_out
The max time that the module waits for the download to complete.
The unit can be ‘s’, ‘m’, ‘h’, ‘d’ and ‘w’.
Future parameter to enforce. Currently we only enforce the recommended 2 minute timeout for cloud API handshake and do not time out for the PTF image download, but we plan to incorporate an enforced time out that factors in the image download time in a future release.
required: Falsetype: strdefault: 15m
Examples
- name: Download an individual PTF
ibm.power_ibmi.ibmi_download_fix_from_cloud:
ptf_id: 'SJ08024'
credentials: {
'machine_model': 'HEX',
'machine_type': '9080',
'serial_number': 'XXXXXXX',
'country': 'US'
}
directory: "~/PTFs/SJ08024"
include_requisites: False
Return Values
- delta
- stdout
- stderr
- cmd
- rc
- entitlement_verified
true- msg
- updates
- download_list