Merge pull request #361 from ritza-co/docs-19.01.11

Docs 19.01.11 release (Week 35, 2024)

docs/auto-discovery/ibm-i-as400.mdx

@@ -0,0 +1,162 @@
+---
+title: "IBM i/AS400 (Midrange)"
+sidebar_position: 13
+---
+
+import ThemedImage from '@theme/ThemedImage'
+import useBaseUrl from '@docusaurus/useBaseUrl'
+
+:::tip
+Are you looking to discover an IBM z/OS-powered mainframe? [Click here to go the z/OS docs page, instead.](z-os-ibm-mainframe.mdx)
+:::
+
+## IBM i/AS400 Discovery Updates
+
+Device42 has enhanced IBM i/AS400 discovery with additional capabilities and device results:
+
+- **Discover Using FTP** allows Device42 to pull in additional discovery details and no longer relies on the Telnet method of discovery.
+- **Discover Software** supports all licensed software that IBM registers as installed. If you use FTP-based discovery, it includes software versions as well. Support encompasses the different programming languages installed, datastore information, and the additional dependencies or tools installed.
+- Disk Space discovery gets the ASPs (Auxiliary Storage Pools) of the machine capacity and space used, and stores the disk information as mount points attached to the device.
+- Tape Drives discovery now brings tape drives in as mount points with tape drive names and model numbers.
+- **Discover Lines of Code** gets the total lines of code, including system files and user files. This information is stored in the extra fields DOQL view in Device42.  Note that this can increase discovery time depending on the number of lines of code.
+- Improved service port collection matches services to specific jobs on the machine.
+
+## Create an IBM i/AS400 (Mid-Range) Discovery Job
+
+To add a new IBM i/AS400 discovery job, head to the main menu and select **Discovery > HyperVisors / \*nix / Windows**. Create a new discovery job, and select "IBM i/AS400" as the **Platform**.
+
+<ThemedImage
+  alt="Add new IBM i/AS400 job"
+  sources={{
+    light: useBaseUrl('/assets/images/ibm-i-as400/as400-discovery-light.png'),
+    dark: useBaseUrl('/assets/images/ibm-i-as400/as400-discovery-dark.png'),
+  }}
+/>
+
+:::caution
+Do not set up an autodiscovery scan using critical production account credentials! Please create a separate, dedicated account to use only for discovery.
+
+Account lock-out could result in an otherwise avoidable outage depending on your permissions and configured password policies. You as a customer are responsible for any such behavior.
+:::
+
+## IBM System i/AS400 Discovery Fields
+
+The following fields are available for configuration when creating a new i/AS400 autodiscovery job:
+
+- **Job Name:** Enter a name of your choosing to identify the IBM i/AS400 autodiscovery job.
+- **Remote Collector:** Optionally, specify a remote collector from which to run discovery instead of the main appliance.
+- **Platform:** Select "IBM i/AS400". 
+- **Discovery Target(s):** Specify the FQDN or IP address of the IBM i/AS400 to discover. If using FQDN, ensure Device42 is set up to resolve DNS. Note that you can configure the DNS in your VM console under option **1**. 
+- **Port:** Only change this if you have a custom listening port configuration. IBM i/AS400 discovery uses port 23 by default.
+- **Discovery Target(s) Credential(s):** Specify a username with permissions on your IBM i/AS400 machine.
+- **Debug Level:** Turn debug on for extra troubleshooting output. This is useful for support tickets. 
+- **ADM Sampling Interval:** Leave off or choose an interval in minutes or hours. 
+- **Discover Using FTP:** Run the discovery through FTP instead of Telnet. 
+- **Timeout:** Specify the maximum time in seconds per command for performing a Telnet discovery. If there are connection issues or slow loading time, increasing the timeout may yield better results. 
+
+    <ThemedImage
+    alt="Timeout"
+    sources={{
+        light: useBaseUrl('/assets/images/ibm-i-as400/timeout-light.png'),
+        dark: useBaseUrl('/assets/images/ibm-i-as400/timeout-dark.png'),
+    }}
+    />    
+
+- **Last Job Status:** This displays the status of the last discovery or task run. 
+- **Job Run Report:** This records changes made in the last task. 
+- **Schedule for autodiscovery:** The discovery job can be scheduled to run automatically. 
+- **Discover Lines of Code**: If selected under the **Software and Applications** section, a script will run to collect the total lines of code on the machine. If used, we recommend increasing the max timeout of the discovery to five minutes or more. 
+
+    <ThemedImage
+    alt="Discover lines of code option"
+    sources={{
+        light: useBaseUrl('/assets/images/ibm-i-as400/software-and-applications-light.png'),
+        dark: useBaseUrl('/assets/images/ibm-i-as400/software-and-applications-dark.png'),
+    }}
+    />        
+
+### FTP Discovery
+
+**How it works:**
+
+Using FTP, Device42 creates a directory on the targeted server named **D42TEST**.
+- Device42 then uploads our CL/RPG programs to the server, transfers them to the QTEMP folder, and runs them.
+- After the CL/RPG programs have run, Device42 transfers the output files back to **D42TEST** and parses them on the remote collector.
+- Finally, Device42 removes all files placed or created on the server and disconnects.
+
+**Advantages over Telnet discovery:**
+
+- FTP discovery does not rely on anything other than the permissions to place or delete files. With Telnet, customization could disrupt the flow and end the discovery.
+- FTP discovery requires less total communication with the server, resulting in much faster run times if there is any slowness on the targeted server or the network.
+
+Due to limitations, Device42 discovery needs to be able to create the directory **D42TEST**. Only the items that were placed or created during discovery will be removed. If an unexpected file is in that directory, the discovery will most likely fail. If discovery fails, please work with your AS400 Server administrator to remove the directory.
+
+## Setting IBM i/AS400 Permissions
+
+Have your AS400 admin run the following command to configure IBM i/AS400 permissions requirements:
+
+```
+CRTUSRPRF USRPRF($USERNAME$) PASSWORD($YOURPASSWORD$) USRCLS(*SECOFR) SPCAUT(*ALLOBJ *JOBCTL)
+```
+
+In the above IBM i/AS400 command:
+
+- Substitute `$USERNAME$` with the profile name of your choice.
+- Substitute `$YOURPASSWORD$` with a strong password of your choice.
+
+:::note
+In `USRCLS(*SECOFR)`, `*SECOFR` may be substituted with `*USER` or `*PGMR` if desired. However, if you choose `*USER`, this option will prevent some software from being discovered. For complete discovery access, choose an option higher than `*USER`.
+:::
+
+For Telnet discovery, please ensure that the created user has the default initial menu (`MAIN`). Customized menus may cause issues when running the discovery.
+
+## AS400 Autodiscovery Details
+
+**What information does discovery gather on the AS400 midrange compute platform?**
+
+- **Hardware Inventory** — including hostname(s), IP & MAC addresses, hardware specifications, and OS information.
+- **Dependencies**
+- **Services**
+- **Service connections**
+
+Sample IBM i/AS400 discovery output:
+
+![IBMi - AS400 discovery output sample data](/assets/images/IBMi-as400_sample_output.png)
+
+## AS400 Limitations
+
+AS400 support does _not_ currently include:
+
+- Individual application discovery
+- Parts support
+
+:::info
+As of Device42 v15.10.00, AS400 discovery has been verified and functionality tested with IBM i/AS400 operating system deployments configured with the Spanish language setting. AS400 discovery should also work with other non-English locale configurations. 
+
+Please let us know about your experiences with other foreign language configurations or any issues you encounter; we love hearing from our users. Email [[email protected]](mailto:[email protected]).
+:::
+
+## Run Now or Schedule
+
+Select **Run Now** from the list page under **Discovery > HyperVisors / \*nix / Windows** to run the job immediately.
+
+<ThemedImage
+  alt="Run now"
+  sources={{
+    light: useBaseUrl('/assets/images/ibm-i-as400/as400-run-now-light.png'),
+    dark: useBaseUrl('/assets/images/ibm-i-as400/as400-run-now-dark.png'),
+  }}
+/> 
+
+
+When creating or editing the job, select **Add another Auto Discovery Schedule** to run the job according to a schedule.
+
+<ThemedImage
+  alt="Schedule IBM i/AS400 job"
+  sources={{
+    light: useBaseUrl('/assets/images/ibm-i-as400/as400-schedule-light.png'),
+    dark: useBaseUrl('/assets/images/ibm-i-as400/as400-schedule-dark.png'),
+  }}
+/> 
+
+Newly created jobs will not run on the first day they are created to prevent an unintentionally large amount of jobs from running initially. If you would like to run a job after its initial creation, select the **Run Now** from the autodiscovery list page.

docs/auto-discovery/index.mdx

@@ -143,11 +143,11 @@ Visit the dedicated page for each machine type:
 
 Discover iLO, iDrac, or other IPMI/BMC boards with basic hardware info and BMC IP and MAC address for a given IP range. If the server has already been discovered by OS-level discovery methods, the BMC IP and MAC address will show up in the device properties.
 
-Visit [IPMI/Redfish Autodiscovery](ipmi-auto-discovery.md) for details.
+Visit [IPMI/Redfish Autodiscovery](ipmi-auto-discovery.mdx) for details.
 
 ## Midrange / Mainframe discovery (IBM AS/400 and z/OS)
 
-Device42 supports agent-less mainframe and mid-range discovery of both the [IBM i / AS400 mid-range](ibm-i-as400.md) platform and the [IBM z/OS mainframe platform](z-os-ibm-mainframe.md).
+Device42 supports agent-less mainframe and mid-range discovery of both the [IBM i / AS400 mid-range](ibm-i-as400.mdx) platform and the [IBM z/OS mainframe platform](z-os-ibm-mainframe.mdx).
 
 ## Network / SNMP Autodiscovery