### Example nmstate Operator Install Plan Output Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=codes-failed-deploy-nmstate-operator Sample output when the nmstate operator install plan is successfully created. ```text NAME CSV APPROVAL APPROVED install-kz5sb kubernetes-nmstate-operator.4.14.0-202311021650 Automatic true ``` -------------------------------- ### Start a policy using the action POST endpoint Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=management-policyenginev1policiespolicy-nameaction-post Use this example to start a policy by applying the 'start' action. Ensure the request is issued on a single line. ```curl curl -k -H 'Authorization: Bearer ' https:///policyengine/v1/pol_2/start -X POST -H ’Content-type: application/json’ ``` -------------------------------- ### Example Output of 'oc get fpa -A' Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=fusion-troubleshooting-upgrade-issues This is an example output showing the phase status of backup policies. Look for applications in the 'InitializeError' phase, such as 'new-mongo-project-1' in this example. ```text oc get fpa -A NAMESPACE NAME PROVIDER APPLICATION BACKUPPOLICY DATACONSISTENCY PHASE LASTBACKUPTIMESTAMP CAPACITY ibm-spectrum-fusion-ns deptest2-azure-hourly-30 isf-ibmspp deptest2 azure-hourly-30 Assigned 66m ibm-spectrum-fusion-ns new-generic-1-azure-hourly-45 isf-ibmspp new-generic-1 azure-hourly-45 Assigned 21m ibm-spectrum-fusion-ns new-mongo-project-1-azure-hourly-15 isf-ibmspp new-mongo-project-1 azure-hourly-15 InitializeError 81m ibm-spectrum-fusion-ns new-mongo-project-azure-hourly-30 isf-ibmspp new-mongo-project azure-hourly-30 Assigned 66m ``` -------------------------------- ### Example of Getting Console Route Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=administering-api-reference This is an example command to get the console route when Fusion is installed in the 'ibm-spectrum-fusion-ns' namespace. ```bash oc get route console -n ibm-spectrum-fusion-ns ``` -------------------------------- ### Example Configuration File Content Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=environment-backing-up-data This is an example of how the configuration file (e.g., data_migration.conf) should be structured with the required variables and their values. ```bash DM_ACTION=BACKUP DM_DATA_PATH=/mnt/bludata0/ DM_TAR_NAME=databackup-2022 ``` -------------------------------- ### Example: Create NamespaceStore account with specific configurations Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=protocol-creating-accounts-namespacestore-file-system-configuration Example of creating a 'testaccount' with full permissions, NamespaceStore configuration, and specified UID/GID. The `--default-resource` flag points to the backing rwx PVC. ```bash noobaa account create testaccount --full_permission --nsfs_account_config --gid 10001 --uid 10001 –default_resource fs_namespacestore ``` -------------------------------- ### Example Request to Get Application Helm Charts Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.8.x?topic=apis-apiapplicationappcataloghelm-get This example demonstrates how to make a GET request to the application app catalog Helm endpoint to fetch details of all installed applications. The output is piped to 'jq' for pretty-printing. ```curl curl -X GET -k -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" https:///api/application/appcatalog/helm | jq ``` -------------------------------- ### Start Sample Application Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=cataloging-using-spectrum-discover-application-catalog Executes the sample application Python script. Ensure all environment variables are set correctly before running. ```bash sudo -E python3 ./ExampleApplication.py ``` -------------------------------- ### Sample CSV Status Output Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=codes-failed-install-csv-isf-operator This is an example of the output from 'oc get csv', indicating that the 'isf-operator.v2.8.0-13104160' CSV has failed to install. ```text NAME DISPLAY VERSION REPLACES PHASE isf-operator.v2.8.0-13104160 IBM Storage Fusion 2.8.0 isf-operator.v2.7.1 Failed ``` -------------------------------- ### Bootstrap VM Created - Non-Empty Output Example Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=codes-bootstrap-vm-is-not-pingable This example shows the output when the bootstrap VM has been successfully created and is running. ```bash sudo virsh list setlocale: No such file or directory Id Name State --------------------------------------------- 1 isf-rackae4-2bztv-bootstrap running ``` -------------------------------- ### Example: Get Specific Node Taints Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.11.x?topic=racks-converting-compute-node-afm-node An example command to get taints for a compute node, demonstrating the usage of the `oc get node` command with a specific node name. ```shell oc get node compute-1-ru10.rackae1.mydomain.com -o=jsonpath='{.spec.taints}' ``` -------------------------------- ### Example: Collect Installer Operator Logs Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.12.x?topic=installing-collecting-log-files-final-installation An example command demonstrating how to collect logs from a specific Installer operator Pod, saving the output to `installer-operator.log`. ```bash oc logs isf-installer-operator-controller-manager-58546db557-qrcrn manager > ./installer-operator.log ``` -------------------------------- ### Start Sample Application Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.9.x?topic=cataloging-using-spectrum-discover-application-catalog Executes the sample application Python script. Requires root privileges and uses the defined environment variables. ```bash sudo -E python3 ./ExampleApplication.py ``` -------------------------------- ### Example GET Response for Application Instance Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=apis-policyenginev1applications-post This is an example GET response that provides Kafka information for an application instance. Use this information to proceed when multiple application instances are detected. ```json { "broker_ip": "localhost", "work_q": "extractapplication_work", "auth": "extractapplication_user:extractapplication_password", "params": "[\"tags\"]", "agent": "extractagent", "broker_port": "9093", "completion_q": "extractapplication_compl", "action_id": "deepinspect" } ``` -------------------------------- ### Get collection users request example Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.8.x?topic=collections-authv1collectionscollection-idusers-get Use this example to get details of users who belong to a specific collection. Ensure you replace placeholders like and with actual values. ```bash curl -k -H ‘Authorization: Bearer ’ https:///auth/v1/collections/a51f84bfeb034b12a9a362109d78bec3/users ``` -------------------------------- ### Example User Creation Request Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.8.x?topic=users-authv1users-post This example demonstrates how to construct a POST request to create a user with specified name, password, and email. The response indicates a successful creation. ```bash curl -k -H 'Content-Type: application/json' -H ‘Authorization: Bearer ’ -X POST https:///auth/v1/users -d ‘{"name":"testuser","password":"testpass", "email":"testuser@ibm.com”}’ ``` -------------------------------- ### Get All Buckets Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=warehouse-db2whrestv1bucket-get This example demonstrates how to get information on all the buckets that are supported by the bucket service by submitting a GET request to the /db2whrest/v1/buckets endpoint. ```APIDOC ## GET /db2whrest/v1/buckets ### Description Retrieves information about all supported buckets. ### Method GET ### Endpoint /db2whrest/v1/buckets ### Request Example ```curl curl -k -H 'Authorization: Bearer https:///db2whrest/v1/buckets -X GET -H "Accept: application/json" ``` ### Response #### Success Response (200) Returns a JSON array of bucket objects, each containing 'name' and 'data' fields. #### Response Example ```json [ { "data": "{\"type\": \"int\", \"source_field\": \"size\", \"ranges\": {\"extra small\": [0, 4096], \"small\": [4096, 1048576], \"extra large\": [1099511627776, \"INFINITY\"], \"large\": [1073741824, 1099511627776], \"medium\": [1048576, 1073741824]}, \"name\": \"SizeRange\"}", "name": "SizeRange" }, { "data": "{\"ranges\": {\"1 year+\": [365, \"INFINITY\"], \"1 quarter\": [30, 90], \"1 year\": [90, 365], \"1 month\": [7, 30], \"1 week\": [0, 7]}, \"source_field\": \"atime\", \"type\": \"date\", \"name\": \"TimeSinceAccess\"}", "name": "TimeSinceAccess" }, { "name": "FileGroup", "data": "{\"name\": \"FileGroup\", \"type\": \"list\", \"ranges\": {\"pdf\": [\"pdf\"], \"doc\": [\"doc\", \"docx\", \"odt\"], \"xls\": [\"xls\", \"xlsm\", \"xlsx\", \"ods\"], \"image\": [\"jpg\", \"jpeg\", \"png\", \"gif\", \"tif\"], \"ppt\": [\"pptx\", \"ppt\", \"pps\", \"odp\"], \"compressed\": [\"zip\", \"tar\", \"gz\", \"z\", \"7z\", \"xz\"], \"text\": [\"txt\", \"rtf\"], \"audio\": [\"mp3\", \"wav\"], \"video\": [\"mp4\", \"mov\", \"mpg\", \"mkv\"], \"medical_image\": [\"img\", \"hdr\", \"nii\", \"mnc\", \"dcm\"], \"genomics\": [\"bam\", \"sam\", \"vcf\"], \"semi_structured\": [\"csv\", \"tsv\", \"avro\", \"json\", \"xml\", \"parquet\"]}, \"source_field\": \"filetype\"}" } ] ``` ``` -------------------------------- ### Sample Kickstart Configuration Snippet (IPv6) Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-control-nodes-creation-failed This is a sample section from a `kickstart-.json` file, illustrating how to find IMM user credentials and node role information using IPv6 addresses. Locate the `OCPRole` to identify the node's hostname. ```json "ipv6ULA": "XXXXXXXXXXXXXXXXXXXXXX", "ipv6LLA": "XXXXXXXXXXXXX", "serialNum": "J1025PXX", "mtm": "7D2XCTO1WW", "ibmSerialNumber": "rackae402", "ibmMTM": "9155-C01", "type": "storage", "OCPRole": "control-1-ru3", "location": "RU2", "name": "IMM_RU2", "bootDevice": "/dev/sda", "users": [ { "user": "CEUSER", "password": "XXXXX", "group": "Administrator", "number": 2 }, { "user": "ISFUSER", "password": "XXXXXX", "group": "Administrator", "number": 3 }, { "user": "USERID", "password": "XXXXXX", "group": "Administrator", "number": 1 } ``` -------------------------------- ### Example Request to Get Collections in a Group Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=groups-authv1groupsgroup-idcollections-get This example demonstrates how to make a GET request to retrieve collections assigned to a specific group. Ensure you replace `` with a valid authentication token and `` with your Spectrum Discover host. The group ID 'a51f84bfeb034b12a9a362109d78bec3' is used as an example. ```bash curl -k -H ‘Authorization: Bearer ’ https:///auth/v1/groups/a51f84bfeb034b12a9a362109d78bec3/collections ``` -------------------------------- ### Sample IMM Configuration for IPv6 Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=codes-cluster-bootstrapping-failed This is a sample section from a `kickstart-.json` file, illustrating the configuration details for a node using IPv6. It shows the `OCPRole` which matches the node's hostname and is used to identify the correct configuration. ```json "ipv6ULA": "XXXXXXXXXXXXXXXXXXXXXX", "ipv6LLA": "XXXXXXXXXXXXX", "serialNum": "J1025PXX", "mtm": "7D2XCTO1WW", "ibmSerialNumber": "rackae402", "ibmMTM": "9155-C01", "type": "storage", "OCPRole": "control-1-ru3", "location": "RU2", "name": "IMM_RU2", "bootDevice": "/dev/sda", "users": [ { "user": "CEUSER", "password": "XXXXX", "group": "Administrator", "number": 2 }, { "user": "ISFUSER", "password": "XXXXXX", "group": "Administrator", "number": 3 }, { "user": "USERID", "password": "XXXXXX", "group": "Administrator", "number": 1 } ``` -------------------------------- ### Example CatalogSource Table Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-failed-deploy-nmstate-operator This is an example output showing available catalog sources. Verify that 'redhat-operators' is listed. ```text NAME DISPLAY TYPE PUBLISHER AGE certified-operators Certified Operators grpc Red Hat 3d9h community-operators Community Operators grpc Red Hat 3d9h ibm-operator-catalog IBM Operator Catalog grpc Red Hat 3d2h isf-data-foundation-catalog Data Foundation Catalog grpc IBM 3d5h isf-catalog. grpc 8h redhat-marketplace Red Hat Marketplace grpc Red Hat 3d9h redhat-operators Red Hat Operators grpc Red Hat 3d9h ``` -------------------------------- ### Example Request to Get Collection Details Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=collections-authv1collectionscollection-id-get This example demonstrates a specific GET request to retrieve details for a collection with ID '51d5bf6c7c4e4fd3b35c53ca91d95705'. Ensure you replace `` and `` with your actual credentials and host. ```bash curl -k -H ‘Authorization: Bearer ’ https:///auth/v1/collections/51d5bf6c7c4e4fd3b35c53ca91d95705 ``` -------------------------------- ### Example debug session and host switch Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.11.x?topic=anr-prerequisite-removing-worker-node-from-fusion-hci-cluster An example demonstrating the sequence of commands to start a debug session, switch to the host environment, and set the fallback option. ```bash ❯ oc debug node/compute-1-ru5.isf-rackae4.mydomain.ibm.com Starting pod/compute-1-ru5isf-rackae4mydomainibmcom-debug-c4jxg ... To use host binaries, run `chroot /host` Pod IP: 172.25.100.28 If you don't see a command prompt, try pressing enter. sh-5.1# chroot /host sh-5.1# mokutil --set-fallback-noreboot true ``` -------------------------------- ### Example: Get Specific Legacy PV Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=sladcnausp-accessing-legacy-application-data-from-openshift-storage-namespace An example command to get the YAML description for a specific legacy PV named `pvc-aa58fb91-c3d2-475b-bbee-68452a613e1a`. This output contains the `volumeAttributes` needed for creating a new PV. ```bash oc get pv pvc-aa58fb91-c3d2-475b-bbee-68452a613e1a -o yaml ``` -------------------------------- ### Get All Supported Buckets Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=warehouse-db2whrestv1bucket-get This example demonstrates how to get information on all the buckets that are supported by the bucket service by making a GET request to the /db2whrest/v1/buckets endpoint. ```APIDOC ## GET /db2whrest/v1/buckets ### Description Retrieves information on all buckets supported by the bucket service. ### Method GET ### Endpoint https:///db2whrest/v1/buckets ### Request Example ```bash curl -k -H 'Authorization: Bearer ' https:///db2whrest/v1/buckets -X GET -H "Accept: application/json" ``` ### Response #### Success Response (200) Returns a JSON array of bucket objects, each containing 'data' and 'name' fields. #### Response Example ```json [ { "data": "{\"type\": \"int\", \"source_field\": \"size\", \"ranges\": {\"extra small\": [0, 4096], \"small\": [4096, 1048576], \"extra large\": [1099511627776, \"INFINITY\"], \"large\": [1073741824, 1099511627776], \"medium\": [1048576, 1073741824]}, \"name\": \"SizeRange\"}", "name": "SizeRange" }, { "data": "{\"ranges\": {\"1 year+\": [365, \"INFINITY\"], \"1 quarter\": [30, 90], \"1 year\": [90, 365], \"1 month\": [7, 30], \"1 week\": [0, 7]}, \"source_field\": \"atime\", \"type\": \"date\", \"name\": \"TimeSinceAccess\"}", "name": "TimeSinceAccess" }, { "name": "FileGroup", "data": "{\"name\": \"FileGroup\", \"type\": \"list\", \"ranges\": {\"pdf\": [\"pdf\"], \"doc\": [\"doc\", \"docx\", \"odt\"], \"xls\": [\"xls\", \"xlsm\", \"xlsx\", \"ods\"], \"image\": [\"jpg\", \"jpeg\", \"png\", \"gif\", \"tif\"], \"ppt\": [\"pptx\", \"ppt\", \"pps\", \"odp\"], \"compressed\": [\"zip\", \"tar\", \"gz\", \"z\", \"7z\", \"xz\"], \"text\": [\"txt\", \"rtf\"], \"audio\": [\"mp3\", \"wav\"], \"video\": [\"mp4\", \"mov\", \"mpg\", \"mkv\"], \"medical_image\": [\"img\", \"hdr\", \"nii\", \"mnc\", \"dcm\"], \"genomics\": [\"bam\", \"sam\", \"vcf\"], \"semi_structured\": [\"csv\", \"tsv\", \"avro\", \"json\", \"xml\", \"parquet\"]}, \"source_field\": \"filetype\"}" } ] ``` ``` -------------------------------- ### Example User Creation Request Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.7.x?topic=users-authv1users-post Demonstrates how to create a user by sending a POST request with user details in JSON format. Ensure the Authorization header contains a valid token. ```bash curl -k -H 'Content-Type: application/json' -H ‘Authorization: Bearer ’ -X POST https:///auth/v1/users -d ‘{"name":"testuser","password":"testpass", "email":"testuser@ibm.com"}’ ``` -------------------------------- ### Sample IMM Configuration for IPv4 Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=codes-cluster-bootstrapping-failed This is a sample section from a `kickstart-.json` file, illustrating the configuration details for a node using IPv4. It includes the `OCPRole` which matches the node's hostname and is used to identify the correct configuration. ```json "ipv4: 165.253.1.7", "serialNum": "J1025PXX", "mtm": "7D2XCTO1WW", "ibmSerialNumber": "rackae402", "ibmMTM": "9155-C01", "type": "storage", "OCPRole": "control-1-ru3", "location": "RU2", "name": "IMM_RU2", "bootDevice": "/dev/sda", "users": [ { "user": "CEUSER", "password": "XXXXX", "group": "Administrator", "number": 2 }, { "user": "ISFUSER", "password": "XXXXXX", "group": "Administrator", "number": 3 }, { "user": "USERID", "password": "XXXXXX", "group": "Administrator", "number": 1 } ``` -------------------------------- ### Verify Submariner Installation Status Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=platform-metro-dr-issues Use 'oc get mdr -oyaml' to check if Submariner is installed. Look for the 'Submariner is not installed' message. ```bash oc get mdr -oyaml ``` ```bash “Submariner is not installed” ``` -------------------------------- ### Sample Install Plan Output Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.10.0?topic=codes-failed-install-fusion-operator This is sample output for the 'oc get ip' command, showing details of the install plan, including approval status. ```text NAME CSV APPROVAL APPROVED install-bcqb4 isf-operator.v2.8.0-13321732 Manual true ``` -------------------------------- ### Example: Mirroring Specific CASE Packages Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=images-mirroring-software-hub-watsonxai-watsonx-orchestrate An example demonstrating the creation of a repository and the addition of specific CASE packages, including `ibm-cert-manager`. ```bash ./casectl repo create --repoPath /Documents/temp ./casectl repo update --repoPath /Documents/temp --addCase ~/.ibm-pak/data/cases/ibm-cert-manager/4.2.18/ibm-cert-manager-4.2.18.tgz ./casectl repo updateoci --repoPath /Documents/temp --addCase ibm-cert-manager --addCaseVersion 4.2.18 --artifactRegistry ```