IBM Cloud Pak System W3550

https://www.ibm.com/docs/en/cloud-pak-system-w3550
Admin
IBM Cloud Pak System W3550 is an integrated platform designed to deploy and manage IBM Cloud Paks,...
Tokens:2,276,853
Snippets:23,554
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Hypervisors - List Example (JSON)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=wm-hypervisors

This example demonstrates the structure of the JSON response when retrieving a list of hypervisors using the GET /resources/hypervisors endpoint. It includes details for two distinct hypervisor entries.

```json
[
{
"address": "https://172.16.15.250/sdk",
"certified": "T",
"cloud": "/resources/clouds/7",
"created": 1254889411919,
"currentmessage": "RM03103",
"currentmessage_text": "Started (move to maintenance mode to make changes)",
"currentstatus": "RM01006",
"currentstatus_text": "Started",
"desiredstatus": "RM01006",
"desiredstatus_text": "Started",
"id": 16,
"name": "virtualwas",
"networks": [
"/resources/networks/38",
"/resources/networks/39"
],
"password": "125488941166924",
"storage": [
"/resources/storage/56",
"/resources/storage/57"
],
"type": "ESX",
"updated": 1254889464232,
"userid": "root"
},
{
"address": "172.16.0.5",
"certified": "T",
"cloud": "/resources/clouds/17",
"created": 1255049179858,
"currentmessage": "RM03103",
"currentmessage_text": "Started (move to maintenance mode to make changes)",
"currentstatus": "RM01006",
"currentstatus_text": "Started",
"desiredstatus": "RM01006",
"desiredstatus_text": "Started",
"id": "PM-19",
"name": "IBM 8204 E8A 10BC4A1",
"networks": [
"/resources/networks/40",
"/resources/networks/41"
],
"password": "125504917100029",
"storage": [
"/resources/storage/58",
"/resources/storage/59",
"/resources/storage/60"
],
"type": "PowerVM",
"updated": 1255049245832,
"userid": "root"
}
]
```

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

### Example Red Hat Linux Client Start Command

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=clients-manually-installing-endpoint-manager

This example demonstrates how to start the IBM Endpoint Manager Client service on a Red Hat Linux system using its init script. This command assumes the client service is managed by the system's init process.

```bash
/etc/init.d/besclient start
```

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

### Start Language Pack Installation Script (Shell)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=agent-installing-language-packs-linux-unix-computer

This command initiates the language pack installation process. It requires navigating to the created directory and specifying the installation destination. The `-i console` flag can be added for non-GUI installations.

```shell
cd dir_name
lpinstaller.sh -c install_dir
```

```shell
cd dir_name
lpinstaller.sh -c install_dir -i console
```

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

### Get Hypervisor by ID - Example (JSON)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=wm-hypervisors

This JSON example illustrates the detailed response received when querying for a specific hypervisor using its ID via the GET /resources/hypervisors/{id} endpoint. It provides all attributes associated with that hypervisor.

```json
{
"address": "172.16.0.5",
"certified": "T",
"cloud": "/resources/clouds/17",
"created": 1255049179858,
"currentmessage": "RM03103",
"currentmessage_text": "Started (move to maintenance mode to make changes)",
"currentstatus": "RM01006",
"currentstatus_text": "Started",
"desiredstatus": "RM01006",
"desiredstatus_text": "Started",
"id": "PM-19",
"name": "IBM 8204 E8A 10BC4A1",
"networks": [
"/resources/networks/40",
"/resources/networks/41"
],
"password": "125504917100029",
"storage": [
"/resources/storage/58",
"/resources/storage/59",
"/resources/storage/60"
],
"type": "PowerVM",
"updated": 1255049245832,
"userid": "root"
}
```

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

### Python Setup Script Example using Maestro Module

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=reference-deployment

An example of a Python setup script (setup/setup.py) that utilizes the 'maestro' module to access configuration parameters passed from the topology document. It demonstrates how to retrieve parameters like agent directory, ports, and IP, and then executes a shell script with these parameters. The script also includes error checking for the executed shell command.

```python
import json
import os
import subprocess
import sys

import maestro

parms = maestro.parms
    
subprocess.call('chmod +x *.sh', shell=True)

rc = subprocess.call('./setup_agent.sh "%s" %d %s %s' % (parms['agent-dir'], parms['http-port'], parms['iaas-ip'], parms['iaas-port']), shell=True)
maestro.check_status(rc, 'setup_agent.sh: rc == %s' % rc)
```

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

### Example Red Hat Linux Client Installation Command

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=clients-manually-installing-endpoint-manager

This example shows the command to install the IBM Endpoint Manager Client on a Red Hat Linux system using the RPM package manager. The '<client_binary>.rpm' should be replaced with the actual downloaded client binary file name.

```bash
rpm -ivh <client_binary>.rpm
```

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

### cbscript.json Example for Application Installation

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=examples-example-script-package-install-application

This JSON configuration defines parameters for installing an application using a script package. It specifies the command to execute, log file location, script location, and command-line arguments, including dynamic keys for application location and installation arguments.

```json
[
  {
      "name": "Install application",
      "version": "1.0.0",
      "description": "This script package installs the specified application",
      "command": "/bin/sh ${WAS_PROFILE_ROOT}/bin/wsadmin.sh",
      "log": "${WAS_PROFILE_ROOT}/logs/wsadmin.traceout",
      "location": "/opt/tmp/installapp",
      "timeout": "0",
      "commandargs": "-lang jython -f /opt/tmp/installapp/install_app.jy $APP_LOCATION $INSTALL_ARGS",
      "type": "APPLICATION",
      "keys":
      [
         {
          "scriptkey": "APP_LOCATION",
     	  "scriptvalue": ""
         },
         {
          "scriptkey": "INSTALL_ARGS",
     	  "scriptvalue": ""
         }
      ]
  }
]
```

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

### Example Script Execution and Output

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=server-running-connecttoexternalgpfsserver-script-package

This is an example of the output log file (remote_std_out.log) after the 'ConnectToExternalGPFSServer' script package has successfully completed. It shows the cluster name, node list, file system details, and the commands executed for remote cluster and file system setup.

```shell
cluster name: Primary_Cluster.purescale.raleigh.ibm.com
node list: 172.17.69.91
file system: fileSystemName
mountpoint: /gpfs/fileSystemName
fileset: testExtFSet1b
link directory: /testExtFSet1bLink
/usr/lpp/mmfs/bin/mmremotecluster add Primary_Cluster.purescale.raleigh.ibm.com -n 172.17.69.91 -k /var/mmfs/ssl/Primary_Cluster.purescale.raleigh.ibm.com_id_rsa.pub
RC is: 0
Message(1) is:  
Message(2) is: mmremotecluster: Command successfully completed

/usr/lpp/mmfs/bin/mmremotefs add fileSystemName -f fileSystemName -C Primary_Cluster.purescale.raleigh.ibm.com -A yes -T /gpfs/fileSystemName
RC is: 0
Message(1) is:  
Message(2) is: 
/usr/lpp/mmfs/bin/mmmount fileSystemName
RC is: 0
Message(1) is:  Tue Jul  1 21:42:10 UTC 2014: mmmount: Mounting file systems ...

Message(2) is: 
ln -s /gpfs/fileSystemName/testExtFSet1b /testExtFSet1bLink
RC is: 0
Message(1) is:  
Message(2) is: 
/usr/lpp/mmfs/bin/mmremotecluster show
RC is: 0
Message(1) is:  Cluster name:    Primary_Cluster.purescale.raleigh.ibm.com
Contact nodes:   172.17.69.91
SHA digest:      9a366c1a33794b8035192bf832389a397cd9330a
File systems:    fileSystemName (fileSystemName)  


Message(2) is: 
/usr/lpp/mmfs/bin/mmremotefs show
RC is: 0
Message(1) is:  Local Name  Remote Name  Cluster name       Mount Point        Mount Options    Automount  Drive  Priority
fileSystemName fileSystemName Primary_Cluster.purescale.raleigh.ibm.com /gpfs/fileSystemName rw               yes          -        0

Message(2) is: 
```

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

### Start Db2 Agent using CandleAgent

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=pw-agent-troubleshooting

This code example demonstrates how to start a Db2 agent using the CandleAgent utility, which is a common solution when the agent fails to come online after a system reboot or Tivoli Enterprise Monitoring Server restart, especially when installed with non-root privileges.

```shell
CandleAgent start
```

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

### Example: Start a Specific Compute Node

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=nodes-compute-start

This example demonstrates how to start a specific compute node, identified by its index in the `admin.computenodes` array. Ensure the index is valid before execution.

```shell
admin.computenodes[0].start()
```

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

### System Command: Start Queue Manager

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=commands-creating-custom-take-action-command

This example demonstrates creating a Take Action command to start an MQSeries queue manager using a system command. It involves selecting 'System Command' as the command type and providing the STRMQM command with the queue manager name as an argument.

```Shell
STRMQM (QMgr)
```

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

### Start Virtual System Instance

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=patterns-virtual-system-instances

Starts a deployed virtual system instance. Requires the deployment ID.

```APIDOC
## POST /virtualsysteminstances/{depl_id}/start

### Description
Starts a deployed virtual system instance.

### Method
POST

### Endpoint
/virtualsysteminstances/{depl_id}/start

### Parameters
#### Path Parameters
- **depl_id** (string) - Required - The ID of the virtual system instance to start.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "Virtual system instance started successfully."
}
```
```

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

### POST /resources/virtualSystems Example

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=management-classic-virtual-system-instances

Example of a POST request to create a virtual system. This requires specifying environment profiles, system names, parts with their configurations (cloud, description, NICs, properties, scripts), and virtual images. The properties detail hardware attributes and WebSphere configurations.

```json
{
    "environmentProfile":"\/resources\/environmentProfiles\/3",
    "name":"MyTest",
    "parts":[
        {
            "cloud":"\/resources\/clouds\/5",
            "count":null,
            "description":"The administrative manager of a deployment cell",
            "id":1,
            "label":"Deployment manager",
            "nics":[
                [
                    {
                        "ipGroup":"\/resources\/ipGroups\/9"
                    }
                ]
            ],
            "properties":[
                {
                    "description":"Number of virtual CPUs required",
                    "key":"numvcpus",
                    "label":"Virtual CPUs",
                    "pclass":"HWAttributes",
                    "type":"integer",
                    "validValues":[
                        "1",
                        "2",
                        "4",
                        "8"
                    ],
                    "value":"1"
                },
                {
                    "description":"Memory size required in megabytes",
                    "key":"memsize",
                    "label":"Memory size (MB)",
                    "pclass":"HWAttributes",
                    "type":"integer",
                    "value":"2048"
                },
                {
                    "description":"Reserve physical CPUs",
                    "key":"physcpures",
                    "label":"Reserve physical CPUs",
                    "pclass":"HWAttributes",
                    "type":"boolean",
                    "value":"false"
                },
                {
                    "description":"Reserve physical memory",
                    "key":"physmemres",
                    "label":"Reserve physical memory",
                    "pclass":"HWAttributes",
                    "type":"boolean",
                    "value":"false"
                },
                {
                    "description":"This is the cell name of the profile",
                    "key":"cell_name",
                    "label":"Cell name",
                    "pclass":"ConfigWAS",
                    "type":"string",
                    "value":"CloudBurstCell"
                },
                {
                    "description":"This is the node name of the profile",
                    "key":"node_name",
                    "label":"Node name",
                    "pclass":"ConfigWAS",
                    "type":"string",
                    "value":"CloudBurstNode"
                },
                {
                    "description":"List of feature packs",
                    "key":"augment_list",
                    "label":"Feature packs",
                    "pclass":"ConfigWAS",
                    "type":"string",
                    "validValues":[
                        "none",
                        "batch",
                        "cea",
                        "jpa",
                        "osgi",
                        "sca",
                        "sdo",
                        "xml"
                    ],
                    "value":[
                        "none"
                    ]
                },
                {
                    "description":"This is the root password for the system",
                    "key":"password",
                    "label":"Password (root)",
                    "pclass":"ConfigPWD_ROOT",
                    "type":"string",
                    "value":"password"
                },
                {
                    "description":"This is the username for the system and websphere",
                    "key":"username",
                    "label":"WebSphere administrative user name",
                    "pclass":"ConfigPWD_USER",
                    "type":"string",
                    "value":"virtuser"
                },
                {
                    "description":"This is the password for the system and WebSphere account",
                    "key":"password",
                    "label":"WebSphere administrative password",
                    "pclass":"ConfigPWD_USER",
                    "type":"string",
                    "value":"password"
                }
            ],
            "scripts":[
                {
                    "description":"Configure IBM HTTP Server on node",
                    "id":1,
                    "label":"Add IBM HTTP Server node",
                    "parameters":[
                        {
                            "key":"ihs",
                            "value":"true"
                        }
                    ]
                }
            ],
            "virtualimage":"\/resources\/virtualImages\/1"
        },
        {
            "cloud":"\/resources\/clouds\/5",
            "count":2,
            "description":"A custom node to be federated into a deployment manager"
        }
    ]
}
```

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

### SMTP Server Configuration Examples

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=server-smtp-setup

Example configuration values for setting the SMTP server URL and reply-to email address. Replace the example values with your actual SMTP server details.

```configuration
admin.settings.mail.smtpserver = "test.smtpserver.com"
admin.settings.mail.replytoaddress= "admin@test.smtpserver.com"
```

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

### Example Private Key File (PEM Format)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=security-importing-console-ssl-certificates-keys

This example illustrates the beginning of a valid private key file in PEM format. Private key files must also be in PEM format.

```text
-----BEGIN RSA PRIVATE KEY-----
MIIEowIBAAKCAQEA0RLL5O6Or3PsiigRwekXlibcfw4At6E4vqbdhbAB/ErfV/gi

```

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

### Interactively Create Virtual System with Pattern Selection

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=methods-wizard-objects-command-line-interface

Illustrates the interactive process of creating a virtual system using the wizard. It highlights how to handle prompts, select from a list of patterns using an asterisk, and the validation feedback mechanism.

```python
>>> w = deployer.wizard()
>>> deployer.virtualsystems.create(w)

Enter ?? for help using the wizard.

name: MyVirtualSystem
pattern (* to select from list): *
1. MyPattern1
2. MyPattern2
3. MyPattern3
pattern (* to select from list):1
```

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

### Example: Get ACL for Cloud User (Direct)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=acl-get-given-user-group

An example demonstrating how to get the ACL for a specific user within a cloud resource. It accesses the first cloud in the admin object and then retrieves the ACL of the first user associated with it.

```python
>>>admin.clouds[0].acl[admin.users[0]]
```

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

### Pure.cli Command Execution Examples

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=interface-starting-in-batch-mode

Demonstrates how to execute commands and Python scripts using the Pure.cli tool. It shows examples of connecting to a system, accepting certificates, and running specific commands or script files with arguments.

```shell
pure -h 172.16.98.225 -u user01 -p password01 --acceptcert -c deployer.patterns
```

```shell
pure -h 172.16.98.225 -u user01 -p password01 --acceptcert -f /SOAPolicyLoader/pureCLI/pure.cli/samples/exportPattern.py --downloadAll -t /SOAPolicyLoader/export
```

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

### Configure Pattern Type Installation with Product Requirements (JSON)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=options-product-specific-settings

This JSON snippet demonstrates how to specify that a pattern type is only installed for a particular product. The 'requires' field with the 'products' array defines the installation constraint. The example shows the pattern type is installed only if the product 'IWD' is present.

```json
{
    "name"        : "patterntype.hello",
    "shortname"   : "ptype.hello",
    "version"     : "2.0.0.1",
    "description" : "DESCRIPTION",
    "builder"     : true,
    "prereqs":{
        "foundation":"2.0.0.1"
    },
    "requires":{
      "products":["IWD"]
    }
}
```

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

### Example: Get ACL for Cloud User (Identifier)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=acl-get-given-user-group

An example demonstrating how to get the ACL for a specific user within a cloud resource using the identifier syntax. This is used when direct access to the user object is not permitted, by specifying the username followed by '?user'.

```python
>>>admin.clouds[0].acl["admin?user"]
```

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

### Start Language Pack Installer in Console Mode

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=packs-windows-systems

This command initiates the language pack installation program in console mode. It requires the path to the IBM Tivoli Monitoring base directory as an argument. This method is useful for automated or remote installations.

```shell
lpinstaller.bat candle_home -i console
```

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

### Start Cloud Pak System Software Agent Instance

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=scpssa-using-command-line-start-external-cloud-pak-system-software-agent-agent-unix-system-linux-computer

Starts a specific instance of the Cloud Pak System Software Agent. Requires the installation directory and the instance name as parameters.

```shell
./itmcmd agent -o instance_name start q8
```

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

### Start Virtual System Instance

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=patterns-virtual-system-instances

Starts a stopped virtual system instance. This action resumes all processes and makes the instance available. The instance ID must be provided to initiate the start command.

```javascript
deployer.virtualsysteminstances.get("d-0d1ede95-f0cf-4d71-9b2e-ffa3bf80871c").start()
```

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

### Start IBM Spectrum Scale UI Service

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=scale-enable-spectrum-user-interface-spectrum

Starts the IBM Spectrum Scale user interface service. This is a prerequisite for accessing the UI.

```shell
systemctl start gpfsgui.service
```

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

### Example Nested Package Structure (XML)

Source: https://www.ibm.com/docs/en/cloud-pak-system-w3550/2.3_topic=fixes-servicexml-reference

Demonstrates a complete example of a `Package` section nested within a `Packages` section for a virtual system emergency fix, including environment variables.

```xml
<rmsd:Packages>
  <rmsd:Package name="IFPK12345" type="ifix" filename="<file_name>.zip" target="APPLICATION">
    <rmsd:EnvVariables>
      <rmsd:EnvVariable key="ENV1" defaultValue="980" type="integer">
      </rmsd:EnvVariable>
    </rmsd:EnvVariables>
  </rmsd:Package>
</rmsd:Packages>
```
Tokens:
Raw