IBM Storage Ceph Plugin for vSphere

https://www.ibm.com/docs/en/ceph-plugin-vsphere
Admin
IBM Storage Ceph Plugin for vSphere provides integration capabilities between VMware vSphere...
Tokens:31,004
Snippets:268
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Example Plugin Status Output

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=installing-installation-overview

Example output of the 'ibm-plugin status' command when the plugin is not registered to any vCenter. Shows the plugin version, build, and 'Plugin Registered' status as 'False'.

```bash
root@IBM-production-ova[~]#ibm-plugin status
Plugin Version: 1.0.0
Plugin Build: 2024_05_01-1120
Plugin Registered: False
```

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

### Example Plugin Status Output

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.1_topic=installing-installation-overview

This is an example output of the 'ibm-plugin status' command, showing the plugin version, build date, and indicating whether it is currently registered with a vCenter instance.

```bash
root@IBM-production-ova[~]#ibm-plugin status
Plugin Version: 1.1.0.0
Plugin Build: 2024_11_21-1120
Plugin Registered: False
```

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

### Interpreting IBM Ceph Plug-in Status Output

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=installing-checking-plug-in-status

This section shows example outputs for the 'ibm-plugin status' command. The first example demonstrates a scenario where the plug-in is registered to multiple vCenters, listing their FQDNs and usernames, along with network configuration. The second example illustrates the output when the plug-in is not registered to any vCenter, indicated by 'Plugin Registered: False'.

```bash
root@IBM-production-ova [ ~ ]# ibm-plugin status
Plugin Version: 1.2.0.0
Plugin Build: 2025_06_01-1120
Plugin Registered: True
Registered vCenters:
+---------------------------------+-----------------------------+
| FQDN                            | Username                    |
+---------------------------------+-----------------------------+
| test-vcsa-1.ssd.hursley.ibm.com | administrator@vsphere.local |
| test-vcsa-2.ssd.hursley.ibm.com | administrator@vsphere.local |
+---------------------------------+-----------------------------+
Network Settings:
+----------+--------------------+
| DHCP     | no                 |
| Address  | x.x.x.x/x          |
| Gateway  | x.x.x.x            |
| DNS-1    | x.x.x.x            |
| DNS-2    | x.x.x.x            |
| Hostname | xx-xxx-xx          |
+----------+--------------------+
 

```

```bash
root@IBM-production-ova [ ~ ]# ibm-plugin status
Plugin Version: 1.2.0.0
Plugin Build: 2025_06_01-1120
Plugin Registered: False
 

```

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

### Example Output: IBM Ceph Plug-in Status (Registered)

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.1_topic=installing-checking-plug-in-status

This is an example of the output when the IBM Ceph plug-in is successfully registered to one or more vCenters. It shows the plug-in version, build date, registration status, a list of FQDNs and usernames for registered vCenters, and network configuration details.

```text
Plugin Version: 1.1.0.0
Plugin Build: 2024_10_25-1120
Plugin Registered: True
Registered vCenters:
+---------------------------------+-----------------------------+
| FQDN                            | Username                    |
+---------------------------------+-----------------------------+
| test-vcsa-1.ssd.hursley.ibm.com | administrator@vsphere.local |
| test-vcsa-2.ssd.hursley.ibm.com | administrator@vsphere.local |
+---------------------------------+-----------------------------+
Network Settings:
+----------+--------------------+
| DHCP     | no                 |
| Address  | x.x.x.x/x          |
| Gateway  | x.x.x.x            |
| DNS-1    | x.x.x.x            |
| DNS-2    | x.x.x.x            |
| Hostname | xx-xxx-xx          |
+----------+--------------------+
 
```

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

### IBM Ceph Plugin vSphere Status - Registered Example

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=installing-checking-plug-in-status

An example output showing a successful registration of the IBM Ceph plugin with vSphere. It lists the plugin version, build, registration status as 'True', and details of two registered vCenters along with their FQDNs and usernames. Network settings are also displayed.

```text
Plugin Version: 1.0.0.0
Plugin Build: 2024_03_07-1120
Plugin Registered: True
Registered vCenters:
+---------------------------------+-----------------------------+
| FQDN                            | Username                    |
+---------------------------------+-----------------------------+
| test-vcsa-1.ssd.hursley.ibm.com | administrator@vsphere.local |
| test-vcsa-2.ssd.hursley.ibm.com | administrator@vsphere.local |
+---------------------------------+-----------------------------+
Network Settings:
+----------+--------------------+
| DHCP     | no                 |
| Address  | x.x.x.x/x          |
| Gateway  | x.x.x.x            |
| DNS-1    | x.x.x.x            |
| DNS-2    | x.x.x.x            |
| Hostname | xx-xxx-xx          |
+----------+--------------------+

```

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

### Copy Snap Log Bundle using scp

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-collecting-snap-support-engagement

This example demonstrates how to securely copy the generated snap log bundle from the plugin appliance to a local machine using the scp command. Replace placeholders with your actual username, appliance IP, and bundle path.

```bash
scp <username>@<appliance_ip>:/tmp/snap.ibm-plugin.<timestamp>.tgz <local_path>
```

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

### Example Output: IBM Ceph Plug-in Status (Not Registered)

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.1_topic=installing-checking-plug-in-status

This is an example of the output when the IBM Ceph plug-in is not registered to any vCenter. The 'Plugin Registered' boolean will be 'False', and no vCenter or network information will be displayed.

```text
Plugin Version: 1.1.0.0
Plugin Build: 2024_10_25-1120
Plugin Registered: False
 
```

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

### IBM Ceph Plugin vSphere Status - Not Registered Example

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=installing-checking-plug-in-status

An example output indicating that the IBM Ceph plugin is not registered with any vCenter. The 'Plugin Registered' field shows 'False', and no vCenter information is listed. Plugin version and build details are still provided.

```text
Plugin Version: 1.0.0.0
Plugin Build: 2024_03_07-1120
Plugin Registered: False

```

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

### Navigate to IBM Plugin Directory

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-manually-updating-photonos-packages

Command to change the current directory to the IBM plugin installation path, typically '/opt/ibm-plugin'. This is a prerequisite step before managing the plugin services.

```shell
cd /opt/ibm-plugin
```

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

### Check PhotonOS Package Security Updates with tdnf

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-manually-updating-photonos-packages

Demonstrates how to check for available PhotonOS package security updates using the 'tdnf updateinfo info' command. It shows examples of output indicating a security update is available and when no updates are needed.

```shell
root@host01 [ ~ ]# tdnf updateinfo info

Name : unzip-6.0-15.ph3.x86_64.rpm
Update ID : patch:PHSA-2020-3.0-0083
Type : Security
Updated : Fri Apr 24 01:15:03 2020
Needs Reboot: 0
```

```shell
root@host01 [ ~ ]# tdnf updateinfo info

0 updates.
```

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

### Generate Snap Log Bundle with ibm-plugin

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-collecting-snap-support-engagement

This command generates a compressed snap log bundle on the plugin appliance. The output includes the filename and path of the created bundle. This bundle is essential for providing diagnostic information to IBM Support.

```bash
ibm-plugin snap
```

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

### View IBM Storage Ceph Plugin for vSphere Logs

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-viewing-logs

This command displays the log file for the IBM Storage Ceph Plugin for vSphere in real-time. It is useful for troubleshooting by allowing you to monitor log entries as they are generated. No specific dependencies are mentioned, and the output is the log content streamed to the console.

```shell
tail -F /opt/persistent/vsphere-plugin.log
```

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

### Update PhotonOS Packages

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-manually-updating-photonos-packages

Command to update all installed PhotonOS packages to their latest available versions. This command should be run after shutting down the plugin containers.

```shell
tdnf update
```

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

### Register IBM vSphere Plugin

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=installing-installation-overview

Command to register the IBM vSphere Plugin with a vCenter instance. Requires vCenter username and the IP or FQDN of the vCenter. The command will prompt for the vCenter password.

```bash
ibm-plugin register -u <vCenter Username> -v <IP_or_FQDN_of_vCenter>
```

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

### Restart IBM Plugin Containers

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=troubleshooting-manually-updating-photonos-packages

Command to start the IBM plugin's Docker containers in detached mode ('-d'). This is performed after updating PhotonOS packages and potentially rebooting the VM.

```shell
docker-compose up -d
```

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

### Register IBM Storage Ceph Plugin for vSphere

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=installing-registering-vsphere-plug-in-into-vcenter

Command to register the IBM Storage Ceph Plugin for vSphere into a vCenter instance. Requires vCenter username and IP address or FQDN. The command will prompt for the vCenter password and display the vSphere instance thumbprint for verification.

```bash
ibm-plugin register -u vCENTER_USERNAME -v IP_OR_FQDN_OF_vCENTER
```

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

### Restart Web App Service with Docker Compose

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.1_topic=configuration-manually-changing-file

This command uses docker-compose to restart the 'web-app' service, which is necessary after updating the plugin configuration. It references the docker-compose.yml file located at /opt/ibm-plugin.

```bash
docker-compose -f /opt/ibm-plugin/docker-compose.yml restart web-app
```

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

### Check IBM Ceph Plugin Status for vSphere

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=installing-checking-plug-in-status

This command retrieves the status of the IBM Ceph plugin registered with vSphere. It displays the plugin version, build date, registration status, and details of linked vCenters. The output also includes network configuration settings.

```bash
ibm-plugin status
```

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

### SSH into IBM Storage Ceph Plugin VM

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.2_topic=installing-deploying-appliance

Connect to the deployed IBM Storage Ceph Plugin virtual machine via SSH. This command assumes you have the IP address of the plugin VM. The initial login uses the default password 'IBMplugin', which must be changed.

```bash
ssh root@IP_ADDRESS_OF_PLUGIN_VM
```

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

### Restart Ceph Plugin Service (Docker Compose)

Source: https://www.ibm.com/docs/en/ceph-plugin-vsphere/1.0_topic=configuration-manually-changing-file

This command uses Docker Compose to restart the IBM plugin web application. It specifies the Docker Compose file to use and the service name to restart. Ensure the Docker Compose file path and service name are correct for your environment.

```bash
docker-compose -f /opt/ibm-plugin/docker-compose.yml ibm-plugin-web-app-1
```
Tokens:
Raw