Fusion HCI Software

https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0
Admin
This project provides comprehensive documentation for Fusion HCI Software, detailing its features,...
Tokens:703,663
Snippets:9,568
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Get All Connection CRs

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=services-disabling-connection

An example of the `oc get connection` command, demonstrating how to retrieve connection details from the 'ibm-spectrum-fusion-ns' namespace.

```bash
oc get connection -n ibm-spectrum-fusion-ns -o=custom-columns='NAME:.metadata.name,ClusterName:.metadata.annotations.connection\.isf\.ibm\.com/cluster-name'
```

--------------------------------

### Example: Full debug session and configuration

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=anr-prerequisite-removing-worker-node-from-fusion-hci-cluster

This example demonstrates the complete sequence of commands, from starting a debug session on a compute node to switching to the host environment and setting 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
```

--------------------------------

### Notifier Startup and Interaction Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=notifications-starting-notifier

This example shows the interactive prompts and output when starting the Notifier, including credential entry and confirmation messages. Note that passwords are not displayed as they are typed.

```text
Starting COS Notifier - Version 0.1
Enter the Manager API username: admin
Enter the Manager API password:
Enter the Kafka username: cos
Enter the Kafka password:
Enter the Kafka pem:
Creating Kafka producer...
Done
Notifier is running
Log file and config file are in directory C:\dev\cos-scanner\output\debug\notifier\20180912-121641-283000
Checking for files in   \data  
- 11 files found Checking for files in output\data  
- 256 files found
```

--------------------------------

### Example: Get IBM Fusion Console Route

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=administering-api-reference

An example of the `oc get route` command, specifying the `ibm-spectrum-fusion-ns` project.

```bash
oc get route console -n ibm-spectrum-fusion-ns
```

--------------------------------

### Install Ansible Toolkit

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=fusion-upgrading-tiebreaker-from-storage-scale-523x-5237

Run the setup command to install the Ansible toolkit on the tiebreaker node. Replace <Tiebreaker IP> with the actual IP address of the tiebreaker virtual machine.

```bash
./spectrumscale setup -s <Tiebreaker IP>
```

--------------------------------

### Sample environment variable values

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=images-mirroring-software-hub-watsonxai-watsonx-orchestrate

Example values for `LOCAL_ISF_REGISTRY` and `LOCAL_ISF_REPOSITORY` to help configure your mirroring setup.

```bash
export LOCAL_ISF_REGISTRY="registryhost.com:443"
export LOCAL_ISF_REPOSITORY="fusion-mirror"
```

--------------------------------

### Example Output for VM Disk Details

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=issues-backup

This is an example output from the 'Get VM Disk Details for Backup Issues' command, showing the name and namespace of a virtual machine with multiple volumes.

```json
{
"name": "rhel9-absent-basilisk",
"namespace": "vmtesting"
}
```

--------------------------------

### Example Running Pods Table

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-failed-deploy-nmstate-operator

Sample output of 'oc get pods' in 'openshift-marketplace', showing running pods.

```text
NAME                                  READY   STATUS             RESTARTS   AGE
isf-catalog-wh8zn                     1/1     Running            0          8h
marketplace-operator-dd4dff8f-jxwm4   1/1     Running            0          32h
redhat-marketplace-d9dl8              1/1     Running            0          32h
redhat-operators-gzk4q                1/1     Running            0          32h
```

--------------------------------

### Example Request to Get Group Users

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=groups-authv1groupsgroup-idusers-get

Use this example to retrieve details of users belonging to a specific group. Ensure you replace <token> and <data_cataloging_host> with your actual credentials and host.

```bash
curl -k  -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/groups/ a51f84bfeb034b12a9a362109d78bec3/users 
```

--------------------------------

### Example Console Route Result

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=administering-api-reference

This is an example output from the `oc get route` command, showing the console's host and port information.

```text
NAME      HOST/PORT                                                                       PATH   SERVICES   PORT    TERMINATION   WILDCARD
console   console-ibm-spectrum-fusion-ns.apps.domain.com                  isf-svc       <all>        reencrypt           None
```

--------------------------------

### Get User Role Assignments Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=users-authv1usersuser-idrole-assignment-get

Use this example to retrieve the details of roles assigned to a specific user. Ensure you replace <token> and <data_cataloging_host> with your actual credentials and host.

```bash
curl -k -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/users/ 4ee5b47f439640d29b6fac7253a64290/role_assignments 
```

--------------------------------

### Example Proxy Configuration Output

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=mcfhuhcp-configuring-hosted-control-plane-cluster-in-proxy-environment

This is an example output from `oc get proxy cluster -o yaml`. It shows the structure and typical values for proxy settings, including httpProxy, httpsProxy, noProxy, and trustedCA.

```yaml
apiVersion: config.openshift.io/v1
kind: Proxy
metadata:
  name: cluster
  resourceVersion: '532'
spec:
  httpProxy: '<http://squid:squid@172.x.y.z:3128'>
  httpsProxy: '<http://squid:squid@172.x.y.z:3128'>
  noProxy: '.mydomain.com,9999,metal3-state.openshift-machine-api,5050,6385,8089,6180,80,8084,169.253.0.0/16'
  trustedCA:
    name: ''
status:
  httpProxy: '<http://squid:squid@172.x.y.z:3128'>
  httpsProxy: '<http://squid:squid@172.x.y.z:3128'>
  noProxy: '.cluster.local,.mydomain.com,.svc,10.128.0.0/14,127.0.0.1,169.253.0.0/16,172.a.b.c/24,172.x.y.z/16,5050,6180,6385,80,8084,8089,9999,api-int.isfdelace.mydomain.com,localhost,metal3-state.openshift-machine-api'
```

--------------------------------

### Create and Update Repository Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=images-mirroring-software-hub-watsonxai-watsonx-orchestrate

Example commands demonstrating the creation of a repository path and updating it with a specific CASE archive and OCI repository.

```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 <private-registry-path>
```

--------------------------------

### Describe Failed Install Plans

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-bmyco0365

If install plans are failing, use this command to get more details about the specific install plan.

```bash
oc describe installplan -n nvidia-gpu-operator
```

--------------------------------

### Example Command with Specific Values

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=sbcrp-setting-bucket-class-replication-policy-using-mcg-command-line-interface

This example demonstrates how to create a placement bucket class with a specific replication policy, using 'bc' as the bucket class name and 'azure-blob-ns' as the backing store.

```bash
noobaa -n openshift-storage bucketclass create placement-bucketclass bc --backingstores azure-blob-ns --replication-policy=/path/to/json-file.json
```

--------------------------------

### Response Example for Get User Roles

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=roles-authv1roles-get

This is an example of the JSON response received when successfully querying the Auth v1 Roles GET API. It lists the available roles with their respective IDs and names.

```json
{
  "roles": [
    {
      "domain_id": null,
      "id": "0ce17850c81a4e5da06ecd93f8ea0393",
      "name": "admin"
    },
    {
      "domain_id": null,
      "id": "383d4b371f244a2a8529a35b665b5c01",
      "name": "datauser"
    },
    {
      "domain_id": null,
      "id": "7d9f6d213b6d4317a395bbf248fdd9b6",
      "name": "collectionadmin"
    },
    {
      "domain_id": null,
      "id": "103bc9b8f1864c19af5663ec357f8d51",
      "name": "dataadmin"
    },
    {
      "domain_id": null,
      "id": "8388af928ce546bea7a0cd804a427b7c",
      "name": "serviceuser"
    }
  ]
}
```

--------------------------------

### Example User Creation Request

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=users-authv1users-post

This example demonstrates how to create a user by sending a POST request with user details in JSON format. Ensure you replace <token> and <data_cataloging_host> with your actual values.

```bash
curl -k -H 'Content-Type: application/json' -H ‘Authorization: Bearer <token>’ -X POST 
https://<data_cataloging_host>/auth/v1/users -d ‘{"name":"testuser","password":"testpass",
"email":"testuser@ibm.com"}’
```

--------------------------------

### Example Commands for Backup & Restore

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=machines-backup-restore-as-code

Example execution of commands for retrieving namespaces, pod IDs, and logs/resources.

```bash
: oc get spectrumfusion -A --no-headers | cut -d" " -f1
> ibm-spectrum-fusion-ns
```

```bash
: oc -n ibm-spectrum-fusion-ns get fusionserviceinstance ibm-backup-restore-service-instance -o json | jq -rc '[(.spec.parameters[]|"\n",.name,.value)]|@csv' | tr -d '"' | grep ",namespace," | cut -d"," -f3
> ibm-backup-restore
```

```bash
: oc get pod -n ibm-backup-restore --field-selector=status.phase=Running --selector=app=backup-service | grep backup-service | head -n 1 | cut -d ' ' -f1
> backup-service-cd597966b-btkgq
```

```bash
: oc exec -it backup-service-cd597966b-btkgq -n ibm-backup-restore -- curl -k https://localhost:9443/dataprotection/backup-service/v1/logs/c2ed99be-6daa-4296-876e-6a027197ef0c/recipe | jq -r '[.logs] | @sh'
```

```bash
: oc exec -it backup-service-cd597966b-btkgq -n ibm-backup-restore -- curl -k https://localhost:9443/dataprotection/backup-service/v1/logs/c2ed99be-6daa-4296-876e-6a027197ef0c/resources | jq -r '[.logs] | @sh'
```

--------------------------------

### Check Submariner Installation Failure

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=platform-metro-dr-issues

Use 'oc get mni -oyaml' to check for Submariner installation failures. If the installation failed, follow the provided workaround.

```bash
oc get mni -oyaml
```

--------------------------------

### Check 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. If it's not, or if there are installation failures, follow the provided workaround.

```bash
oc get mdr -oyaml
```

--------------------------------

### Sample IMM User Interface Configuration (IPv6)

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-cluster-bootstrapping-failed

This sample section from the 'kickstart-.json' file shows how to find user credentials and node details, specifically for IPv6 addresses.

```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 }
```

--------------------------------

### Get Policy Preview

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=management-policyenginev1policiespolicy-namepreview-get

This example shows how to get the policy preview information about a specific policy that is configured in the system.

```APIDOC
## GET /policyengine/v1/policies/{policy_name}/preview

### Description
Retrieves a preview of the configuration for a specific policy.

### Method
GET

### Endpoint
/policyengine/v1/policies/{policy_name}/preview

### Parameters
#### Path Parameters
- **policy_name** (string) - Required - The name of the policy to preview.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -k -H 'Authorization: Bearer <token>' https://<data_cataloging_host>/policyengine/v1/policies/<policy_name>/preview -X GET -H 'Accept: application/json'
```

### Response
#### Success Response (200)
- **schedule** (object) - The schedule details for the policy.
  - **minute** (string) - The minute of the schedule.
  - **hour** (string) - The hour of the schedule.
  - **dayOfMonth** (string) - The day of the month for the schedule.
  - **month** (string) - The month for the schedule.
  - **dayOfWeek** (string) - The day of the week for the schedule.
  - **timezone** (string) - The timezone for the schedule.
- **next_run_time** (string) - The next scheduled run time.
- **estimation_info** (object) - Information about the estimated resources.
  - **document_count** (integer) - The total number of documents.
  - **total_size** (integer) - The total size of the documents.
  - **total_size_on_disk** (integer) - The total size on disk.
- **execution_info** (object) - Information about the policy execution.
  - **start_time** (string) - The start time of the execution.
  - **duration** (integer) - The duration of the execution in milliseconds.
  - **tier_count** (integer) - The number of tiers.
  - **tier_size** (integer) - The size of each tier.
  - **failed_count** (integer) - The number of failed executions.

#### Response Example
```json
{
  "schedule": {
    "minute": "18",
    "hour": "12",
    "dayOfMonth": "*",
    "month": "*",
    "dayOfWeek": "*",
    "timezone": "UTC"
  },
  "next_run_time": "2020-03-19 12:18PM",
  "estimation_info" : {
    "document_count": 152467,
    "total_size": 24935050549,
    "total_size_on_disk": 25610976130
   },
  "execution_info": {
    "start_time": "",
    "duration": 3000,
    "tier_count": 10345,
   "tier_size": 1000000,
   "failed_count": 0
  }
}
```
```

--------------------------------

### Sample IMM User Interface Configuration (IPv4)

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-cluster-bootstrapping-failed

This sample section from the 'kickstart-.json' file shows how to find user credentials and node details, specifically for IPv4 addresses.

```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 }
```

--------------------------------

### Example Virtual Machine Instance Migration Configuration

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=machines-live-migration-virtual

An example of a completed `migrate.yaml` file, ready to be applied for initiating a migration.

```yaml
apiVersion: kubevirt.io/v1
kind: VirtualMachineInstanceMigration
metadata:
  name: migration-job
  namespace: openshift-cnv
spec:
  vmiName: icsvm-storage-gui-kocmddajec
```

--------------------------------

### Get User Roles Request Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=users-authv1usersuser-idroles-get

An example cURL request to retrieve roles for a user with a specific ID.

```bash
curl -k -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/users/4ee5b47f439640d29b6fac7253a64290/roles 

```

--------------------------------

### Example Request to Get Collection Details

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=collections-authv1collectionscollection-id-get

This example demonstrates a specific cURL request to fetch details for a collection with the ID '51d5bf6c7c4e4fd3b35c53ca91d95705'.

```bash
curl -k  -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/collections/51d5bf6c7c4e4fd3b35c53ca91d95705
```

--------------------------------

### Bootstrap VM Created (Example Output)

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-bootstrap-vm-is-not-pingable

This is an example output of `sudo virsh list` when the bootstrap VM is running.

```bash
sudo virsh list
setlocale: No such file or directory
Id   Name                          State
---------------------------------------------
1    isf-rackae4-2bztv-bootstrap   running
```

--------------------------------

### Sample Kickstart Configuration Snippet (IPv6)

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-control-nodes-creation-failed

A sample section from a kickstart configuration file (`kickstart-.json`) showing how to find IMM user credentials and node role information. This is used to access the IMM user interface of a Baremetal node when debugging.

```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
          }

  
```

--------------------------------

### Run Harvester CLI setup script

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=cataloging-data-harvester-cli

Make the Harvester CLI setup script executable and then run it to complete the installation and configuration.

```bash
chmod +x ./harvester/setup.sh
./harvester/setup.sh
```

--------------------------------

### Example Configuration File with Values

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=cataloging-data-harvester-cli

Provides example values for the CLI configuration file, including ConsoleRouteURL, ImportCSVRouteURL, AdminUsername, and AdminPassword.

```ini
ConsoleRouteURL = https://console-ibm-data-cataloging.apps.<domain>
ImportCSVRouteURL = https://isd-import-service-ibm-data-cataloging.apps.<domain>
AdminUsername = sdadmin
AdminPassword = Passw0rd
```

--------------------------------

### Get Event Stats API

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=reference-serviceability-apis

Retrieves statistics for events. Use the 'query' parameter to filter, for example, 'Fixed=false' to get unfixed events.

```HTTP
GET /api/v1/eventmanager/eventstats?${query}
```

--------------------------------

### Example Recipe for Resource Backup and Restore

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=workflows-creating-recipe

This example demonstrates how to define a recipe for backing up and restoring specific resources, including their statuses. It uses `includedNamespaces` and `labelSelector` to target resources and `restoreStatus` with `includedResources` to specify which resource statuses to preserve.

```yaml
- name: keycloak-resources
   type: resource  
   includedNamespaces:
   - cp4i
  labelSelector: foundationservices.cloudpak.ibm.com=keycloak
  restoreStatus:    
    includedResources:
    - integrationkeycloakclients.keycloak.integration.ibm.com
    - integrationkeycloakusers.keycloak.integration.ibm.com 
```

--------------------------------

### Example LoadBalancer Service Output

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=foundation-configuring-regional-dr

This is an example of the output from the `oc get svc` command, showing the IP address and port for the `ocs-provider-server-load-balancer` service.

```text
ocs-provider-server-load-balancer   LoadBalancer   172.30.213.146   172.200.88.109   50051:30506/TCP   6d   app=ocsProviderApiServer
```

--------------------------------

### Sample IPv4 Configuration in kickstart-.json

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-failed-control-nodes-inspection

This JSON snippet illustrates the structure of the kickstart-.json file for a node with an IPv4 address, detailing network interfaces, NVMe drives, and other hardware specifics.

```json
{
       "OCPRole": "compute-1-ru7",
       "bootDevice": "/dev/disk/by-path/pci-0000:01:00.0-nvme-1",
       "ibmMTM": "9155-D10",
       "ibmSerialNumber": "delld07",
       "ipv4": "169.253.1.7",
       "ipv6LLA": "",
       "ipv6ULA": "",
       "location": "RU7",
       "manufacturer": "Dell",
       "mtm": "2668",
       "name": "IMM_RU7",
       "networkCards": [
        {
         "slot-1": [
          "30:3E:A7:10:80:2A",
          "30:3E:A7:10:80:2B",
          "30:3E:A7:10:80:2C",
          "30:3E:A7:10:80:2D"
         ],
         "slot-2": [
          "5C:25:73:C9:94:3E",
          "5C:25:73:C9:94:3F"
         ]
        }
       ],
       "networkInterfaces": [
        {
         "interfaceLeg1": "ens2f0np0",
         "interfaceLeg2": "ens2f1np1",
         "interfaceName": "bond0",
         "interfaceType": "baremetal",
         "macAddress": "5c:25:73:c9:94:3e",
         "secondaryMacAddress": "5C:25:73:C9:94:3F"
        },
        {
         "interfaceLeg1": "eno12409",
         "interfaceLeg2": "eno12419",
         "interfaceName": "bond1",
         "interfaceType": "provisioning",
         "macAddress": "30:3e:a7:10:80:2b",
         "secondaryMacAddress": "30:3E:A7:10:80:2C"
        }
       ],
       "nodeIndex": "6",
       "nvme": [
        {
         "capacity": "3576.983 GB",
         "location": "PCIe SSD in Slot 0 in Bay 1",
         "manufacture": "Micron Technology Inc",
         "productName": "Dell DC NVMe ISE 7450 RI U.2 3.84TB",
         "serialNumber": "2415487E9851"
        },
        {
         "capacity": "3576.983 GB",
         "location": "PCIe SSD in Slot 1 in Bay 1",
         "manufacture": "Micron Technology Inc",
         "productName": "Dell DC NVMe ISE 7450 RI U.2 3.84TB",
         "serialNumber": "2415487EDAAC"
        }
       ],
       "pxeSlotLabel": "NIC.Integrated.1-2-1",
       "secretName": "compute-1-ru7-secret",
       "serialNum": "9Y47NW3",
       "type": "storage",
       "unusedInterfaces": [
        "ens4f0np0",
        "ens4f1np1",
        "ens4f2np2",
        "ens4f3np3"
       ],
       "uuid": "uuid"
      }
     ],


```

--------------------------------

### Example Request to Get Group Roles

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=groups-authv1groupsgroup-idroles-get

Use this example to retrieve the user roles assigned to a specific group by providing the group ID in the URL.

```bash
curl -k  -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/groups/ a51f84bfeb034b12a9a362109d78bec3/roles
```

--------------------------------

### Get Installer Operator Logs

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=installing-collecting-log-files-final-installation

Fetch the log file for the Installer operator. Replace `<Installer operator Pod's name>` with the actual Pod name obtained in the previous step. The container name is 'manager'.

```bash
oc logs <Installer operator Pod's name> manager > ./installer-operator.log
```

```bash
oc logs isf-installer-operator-controller-manager-58546db557-qrcrn manager > ./installer-operator.log
```

--------------------------------

### Example Service Account Creation

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=aladfosn-modifying-selinux-label-only-deployment-config-that-has-pod-which-mounts-legacy-application-pvc

Example of creating a service account named 'testnamespacesa'.

```bash
oc create serviceaccount testnamespacesa
```

--------------------------------

### Get User Groups Response Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=users-authv1usersuser-idgroups-get

This is an example of the JSON response when successfully retrieving user group details. It lists the name, description, and domain for each group.

```json
{
    "groups": [
        {
            "name": "test-group1",
            "description": "Test Group 1",
            "domain": "default"
        },
        {
            "name": "test-group2",
            "description": "Test Group 2",
            "domain": "default"
        }
    ]
}

```

--------------------------------

### Get Installer Operator Pod Name

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=installing-collecting-log-files-final-installation

Retrieve the name of the Installer operator's Pod using its label selector. This name is needed to fetch its logs.

```bash
oc get po -l control-plane=isf-installer-operator
```

--------------------------------

### Sample IPv6 Configuration in kickstart-.json

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=codes-failed-control-nodes-inspection

This JSON snippet shows the structure of the kickstart-.json file for a node with an IPv6 address, including OCPRole and user credentials.

```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
          }


```

--------------------------------

### Access Services with Token

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=tokens-authv1token-get

This example demonstrates how to use an obtained authentication token to access services, such as retrieving policies from the policy engine. Replace the token and `<data_cataloging_host>` with your specific values.

```bash
curl -v -k -H ‘Authorization: Bearer gAAAAABbUdgLOLk67Zk_XQO0bbJt_qe4suz449m7XLM-
D6e0jUzDxBW574L38y5xF5y3wc-Xq0Bp43uQH13QN-wTsioPoOfOlbyrN5avBag2iHUkCOgXyA46TvY5LdGu46LEs-
gO-qidQgUCg5im4QF3Zvw5enCTvQd2N1bAg186CVOc8Qk5o1ldJGd51nL3ELts0LsVg9F4oPhv9HixwZflhlCsuPg1Gw’ 
https://<data_cataloging_host>/policyengine/v1/policies
```

--------------------------------

### Get IBM Fusion Console Route

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=administering-api-reference

Run this command to obtain the console route for your IBM Fusion installation. Replace `<namespace where fusion is installed>` with the actual namespace.

```bash
oc get route console -n <namespace where fusion is installed>
```

--------------------------------

### Example CLI Output for Creating BackingStore

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=interface-creating-cos-backed-backingstore

This output shows the successful creation of a backingstore, secret, and related resources via the MCG command-line interface.

```bash
INFO[0001] ✅ Exists: NooBaa "noobaa"
INFO[0002] ✅ Created: BackingStore "ibm-resource"
INFO[0002] ✅ Created: Secret "backing-store-secret-ibm-resource"

```

--------------------------------

### GCP Backing Store CLI Output Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=interface-creating-gcp-backed-backingstore

This is an example of the output you can expect after successfully creating a GCP-backed backing store using the MCG CLI.

```bash
INFO[0001] ✅ Exists: NooBaa "noobaa"
INFO[0002] ✅ Created: BackingStore "google-gcp"
INFO[0002] ✅ Created: Secret "backing-store-google-cloud-storage-gcp"
```

--------------------------------

### Create Directory and Move Discovery ISO

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=dbmcfdf-booting-up-bare-metal-hosted-control-plane-nodes-through-cli

Create a directory on the service node to host the discovery ISO and move the downloaded ISO file into it.

```bash
mkdir /var/www/html/discovery-isos
# move the ISO to:
mv discovery.iso /var/www/html/discovery-isos
```

--------------------------------

### Get User Groups Request Example

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=users-authv1usersuser-idgroups-get

Use this example to retrieve the details of groups to which a specific user belongs. Ensure the Authorization token and data cataloging host are correctly set.

```bash
curl -k -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/users/ 4ee5b47f439640d29b6fac7253a64290/groups 
```

--------------------------------

### Create Image Directory and Pull Image

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=overview-verifying-image-signatures

Create a directory to store the image and use `skopeo` to copy the image from the registry to local storage. Replace `<version of Fusion being installed/verified>` with the actual version.

```bash
mkdir images
FUSION_VERSION=<version of Fusion being installed/verified>
skopeo copy docker://icr.io/cpopen/isf-operator-catalog:${FUSION_VERSION}-linux.amd64 dir:./images
```

```bash
mkdir images
FUSION_VERSION=2.13.0
skopeo copy docker://icr.io/cpopen/isf-operator-catalog:${FUSION_VERSION}-linux.amd64 dir:./images
```

--------------------------------

### Get All Supported Buckets

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=warehouse-db2whrestv1bucket-get

This example demonstrates how to retrieve information on all buckets supported by the bucket service.

```APIDOC
## GET /db2whrest/v1/buckets

### Description
Retrieves information about all buckets supported by the bucket service.

### Method
GET

### Endpoint
/db2whrest/v1/buckets

### Request Example
```bash
curl -k -H 'Authorization: Bearer <token> https://<data_cataloging_host>/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 Guardian Configuration

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=scaling-backup-restore-resource-self-monitoring

This example shows how to configure memory and CPU thresholds, and the monitoring duration in seconds within the `guardian-configmap`. Defaults are 85% for thresholds and 300 seconds for duration.

```yaml
memoryThresholdPercentage: '85'
cpuThresholdPercentage: '85'
monitorDurationInSeconds: '300'
```

--------------------------------

### Get Policy Log Execution Details

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=management-policyenginev1policyhistorypol-idlog-id-get

This example demonstrates how to retrieve the policy log execution details for policies accessible to the user. It uses a GET request to the specified endpoint with an authorization token.

```APIDOC
## GET /policyengine/v1/policyhistory/{policyId}/{logId}

### Description
Retrieves the execution details for a specific policy's log.

### Method
GET

### Endpoint
https://<data_cataloging_host>/policyengine/v1/policyhistory/patent_pol/893909178

### Parameters
#### Path Parameters
- **policyId** (string) - Required - The ID of the policy.
- **logId** (string) - Required - The ID of the log entry.

#### Headers
- **Authorization**: Bearer ${TOKEN}
- **Accept**: application/json

### Request Example
```bash
curl -k -H 'Authorization: Bearer ${TOKEN}' https://<data_cataloging_host>/policyengine/v1/policyhistory/patent_pol/893909178 -X GET -H 'Accept: application/json'
```

### Response
#### Success Response (200)
- **log** (string) - A string containing the detailed execution log of the policy.
```

--------------------------------

### Example Request to Get Collection Groups

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=collections-authv1collectionscollection-idgroups-get

This example demonstrates a cURL request to fetch user groups for a specific collection ID. Ensure you replace `<token>` and `<data_cataloging_host>` with your actual credentials and host.

```bash
curl -k  -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/collections/a51f84bfeb034b12a9a362109d78bec3/groups
```

--------------------------------

### Example: Create AFM Fileset with NFS Home

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=data-active-file-management-afm-fileset-creation

An example of creating an AFM fileset using NFS as home, with specific details for fileset name, path, target, and mode.

```bash
curl -k -H "Authorization:Token <token retreived from the previous command>" -X POST --header 'content-type:application/json' --header 'accept:application/json' -d '{ "filesetName": "afmfsetnfs", "path": "/mnt/ibmspectrum-fs/afmfsetnfs", "afmTarget": "nfs://9.9.9.9/mnt/fs1/fset1", "afmMode": "independent-writer" }' https://ibm-spectrum-scale-gui-ibm-spectrum-scale.apps.isf.ibm.com/scalemgmt/v2/filesystems/ibmspectrum-fs/filesets
```

--------------------------------

### Start and Enable httpd Service

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=hci-rack-reset

Use these commands to start the httpd service if it is stopped and ensure it starts automatically on boot.

```bash
systemctl start httpd
systemctl enable httpd
```

--------------------------------

### Example of DNS Lookup Failure in Network Pre-check

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=installing-installation-issues

This example illustrates the error message observed when the installation fails due to duplicate IP addresses being returned for a hostname during the stage 2 network pre-check.

```text
For node at RU5 the lookup of IP address from hostname compute-1-ru5.testdomain.com failed with error DNS lookup of hostname compute-1-ru5.testdomain.com returning 2 IPs. Expected exactly 1 Ip....
```

--------------------------------

### Get Specific Group Collections Request

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=groups-authv1groupsgroup-idcollections-get

Example of a cURL request to get details of collections assigned within a specific user group. Ensure you replace the placeholder group ID with a valid one.

```bash
curl -k  -H ‘Authorization: Bearer <token>’ https://<data_cataloging_host>/auth/v1/groups/a51f84bfeb034b12a9a362109d78bec3/collections
```

--------------------------------

### Example Output for kubemacpool-mac-controller-manager

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=rdcfdf-enabling-granular-disaster-recovery-individual-groups-virtual-machines-in-namespace-technology-preview

This is an example output showing the status of the `kubemacpool-mac-controller-manager` pod after a restart.

```text
kubemacpool-mac-controller-manager-544ff96b4f-dgb7x    2/2     Running   3               30h
```

--------------------------------

### Example Replay Process Output

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=notifications-starting-replay

This output demonstrates a typical Replay execution, from log extraction to completion. It shows the download progress and confirmation messages.

```text
Starting COS Replay - Version 0.1 Log file and config file are in directory /Users/weebrew/
Documents/Development/ibmworkspace/cosscanner/output/debug/scanner/20180925-125528-232131
Starting Accessor Log Extraction Downloading files...
('Downloaded', 10, 'of', 36)
('Downloaded', 20, 'of', 36)
('Downloaded', 30, 'of', 36)
Download complete.
Total files: 36
Complete Accessor Log Extraction
Starting Replay process
Complete Replay process
```

--------------------------------

### Create a data bucket

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=blmog-enabling-bucket-logging-by-using-best-effort-option

Use this command to create the bucket that will store your data.

```bash
odf nb bucket create data.bucket
```

--------------------------------

### Start Replay Command

Source: https://www.ibm.com/docs/en/fusion-hci-systems/2.13.0?topic=notifications-starting-replay

Execute this command in the terminal to initiate the Replay process. Ensure Replay is configured according to the specified guidelines.

```bash
cos-replay
```
Tokens:
Raw