iProd

class iProd(conn)

Note

Deprecated: Will be removed in the next major version.

Arguments

• conn (Connection) – The Connection object.

iProd.getInstalledProducts(cb)

Note

Deprecated: Will be removed in the next major version.

Retrieve the list of all installed products. IBM i API: QSZSLTPR

Arguments

• cb (getInstalledProductsCallback) – the callback function

iProd.getPTFInfo(PTFID, cb)

Note

Deprecated: Will be removed in the next major version.

Retrieve the load status of specified PTF. IBM i API: QPZRTVFX

Arguments

• PTFID (string) – The PTF number to be queried

• cb (getPTFInfoCallback) – The callback function.

iProd.getProductInfo(prodID, option, cb)

Note

Deprecated: Will be removed in the next major version.

Retrieve the status of the specified product. IBM i API: QSZRTVPR

Arguments

• prodID (string) – The product id.

• option (number) – The product option.

• cb (getProductInfoCallback) – The callback function.

getPTFInfoCallback(error, output)

Arguments

• error (Error|null) – the error object if an error occured or null.

• output (getPTFInfoOutput|null) – This is an object if successful or null when an error occurs.

getPTFInfoOutput()

getPTFInfo Output Object

Arguments

• Product_ID (string) –

• PTF_ID (string) –

• Release_level (string) –

• Product_option (string) –

• Load_ID (string) –

• Loaded_status (string) –

• Cover_letter_status (string) –

• On-order_status (string) –

• Save_file_status (string) –

• File_name (string) –

• File_library_name (string) –

• PTF_type (string) –

• IPL_action (string) –

• Action_pending (string) –

• Action_required (string) –

• PTF_is_released (string) –

• Target_release (string) –

• Superseding_PTF (string) –

• Current_IPL_source (string) –

• Minimum_level (string) –

• Maximum_level (string) –

• Format_information_available (string) –

• Status_date_and_time (string) –

• Licensed_Internal_Code_group (string) –

• Superseded_by_PTF_ID (string) –

• Current_server_IPL_source (string) –

• Server_IPL_required (string) –

• Creation_date_and_time (string) –

• Technology_refresh_PTF (string) –

getProductInfoCallback(error, output)

Arguments

• error (Error|null) – the error object if an error occured or null.

• output (getProductInfoOutput|null) – This is an object if successful or null when an error occurs.

getProductInfoOutput()

getProductInfo Output Object

Arguments

• Product_ID (string) –

• Release_level (string) –

• Product_option (string) –

• Load_ID (string) –

• Loaded_type (string) –

• Symbolic_load_state (string) –

• Load_error_indicator (string) –

• Load_state (string) –

• Supported_flag (string) –

• Registration_type (string) –

• Registration_value (string) –

• Offset_to_additional_information (string) –

• Primary_language_load_identifier (string) –

• Minimum_target_release (string) –

• Minimum_VRM_of_*BASE_required_by_option (string) –

• Requirements_met_between_base_and_option_value (string) –

• Level (string) –

getInstalledProductsCallback(error, output)

Arguments

• error (Error|null) – the error object if an error occured or null.

• output (getInstalledProductsOutput|null) – This is an object if successful or null when an error occurs.

getInstalledProductsOutput()

getInstalledProducts Output Object

Arguments

• Product_ID (string) –

• Product_option (string) –

• Release_level (string) –

• Description_text_message_ID (string) –

• Description_text_object_name (string) –

• Description_text_library_name (string) –

• Installed_flag (string) –

• Supported_flag (string) –

• Registration_type (string) –

• Registration_value (string) –

• Description_text (string) –

Examples

Retrieve basic PTF info

const { Connection, iProd } = require('itoolkit');

const connection = new Connection({
  transport: 'ssh',
  transportOptions: { host: 'myhost', username: 'myuser', password: 'mypassword' },
});

const prod = new iProd(connection);

prod.getPTFInfo('SI54708', (error, output) => {
  if (error) {
    throw error;
  }
  console.log(output);
});

Retrieve basic information about the product load

const { Connection, iProd } = require('itoolkit');

const connection = new Connection({
  transport: 'ssh',
  transportOptions: { host: 'myhost', username: 'myuser', password: 'mypassword' },
});

const prod = new iProd(connection);

prod.getProductInfo('5770DG1', (error, output) => {
  if (error) {
    throw error;
  }
  console.log(output);
});

Retrieve the list of all installed products

const { Connection, iProd } = require('itoolkit');

const connection = new Connection({
  transport: 'ssh',
  transportOptions: { host: 'myhost', username: 'myuser', password: 'mypassword' },
});

const prod = new iProd(connection);

prod.getInstalledProducts((error, output) => {
  if (error) {
    throw error;
  }
  console.log(output);
});