IBM Cloud Pak System Software

https://www.ibm.com/docs/en/cloud-pak-system-software
Admin
IBM Cloud Pak System Software provides a platform for deploying and managing IBM Cloud Paks and...
Tokens:2,773,746
Snippets:42,119
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example URL for Listing Repositories

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=wm-installation-manager-repository

An example URL demonstrating how to list Installation Manager repositories with detailed information in English.

```shell
https://localhost/resources/imrepositories/internal/categories?showdetail=true&language=en
```

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

### Start Installation with Software Power Type

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=icpss-installing-in-interactive-mode

Initiate the installation process using the install.sh script with the 'software_power' installation type.

```bash
#!/bin/bash
./install.sh -t software_power
```

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

### Example: Starting a Specific Compute Node

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=cn-compute-node-start

This example demonstrates how to start the first compute node in the list (index 0). This command is typically used in an administrative context.

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

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

### Start a Virtual Machine

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=vm-virtual-machines-start

Use the `virtualmachine.start()` command to initiate a virtual machine. The example demonstrates how to start the first virtual machine in the admin list.

```APIDOC
## virtualmachine.start()

### Description
Starts a virtual machine.

### Method
```
virtualmachine.start()
```

### Endpoint
N/A (SDK method)

### Parameters
None

### Request Example
```
admin.virtualmachines[0].start()
```

### Response
N/A (SDK method)
```

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

### Start Language Pack Installer

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=agent-installing-language-packs-linux-unix-computer

Navigates to the temporary directory and starts the language pack installation program. Replace `install_dir` with your IBM Tivoli Monitoring installation path.

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

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

### Response Body Example for Listing Repositories

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=wm-installation-manager-repository

An example JSON response body when listing Installation Manager repositories with detailed information.

```json
[
    {
        "isdeletable": "true",
        "name": "Test",
        "id": "Test",
        "children": [
            {
                "isdeletable": "false",
                "name": "8.5.0.0-WS-BPM-IFJR48531",
                "id": "8.5.0.0-WS-BPM-IFJR48531",
                "description": "COACHGENERATORCONTEXTMANAGER SHOWS MEMORY LEAK BEHAVIOR",
                "children": [
                    {
                        "plugins": [],
                        "version": "8.5.0.20131121_1257",
                        "type": "Fix",
                        "productid": "8.5.0.0-WS-BPM-IFJR48531",
                        "isdeletable": "true",
                        "name": "8.5.0.0-WS-BPM-IFJR48531",
                        "id": "8.5.0.0-WS-BPM-IFJR48531_8.5.0.20131121_1257",
                        "displayid": "8.5.0.0-WS-BPM-IFJR48531"
                    }
                ]
            }
        ]
    }
]
```

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

### Example URL for Uploading Package

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=wm-installation-manager-repository

An example URL for uploading a software package to a specific category within the internal Installation Manager repository.

```shell
https://localhost/resources/imrepositories/internal/categories/TestZip/packages
```

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

### Restoring Servicd64 to Online State During Installation

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=support-known-issues-limitations

Follow these commands to bring the Service64 component to an online state if it gets stuck in 'Failed offline' during installation. This involves stopping and starting specific services and checking database connectivity.

```bash
/data/purescale-install/tsa/runTSAServerCommand.sh stop ipas-float- db2instance-db2inst 2>&1 | /data/purescale-install/tsa/tsalogger.sh ipas-float- db2instance-db2inst stop ; (exit $PIPESTATUS)
```

```bash
/data/purescale/db2_11.5.8.0/bin/db2gcf -s -i db2inst
```

```bash
/data/purescale-install/tsa/runTSAServerCommand.sh start ipas-float- db2instance-db2inst 2>&1 | /data/purescale-install/tsa/tsalogger.sh ipas-float- db2instance-db2inst start ; (exit $PIPESTATUS)
```

```bash
/data/purescale/db2_11.5.8.0/bin/db2gcf -s -i db2inst
```

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

### Example: Prepare Backup Directory on Source VM

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=migration-db2-workload

Example commands to log in to the source VM and create a Db2 backup directory.

```bash
# ssh root@xxx.xxx.xxx.xxx
```

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

### Example Log Entry for 'Unable to get attribute name' Error

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.4?topic=st-general-situation-problems

This log entry illustrates a typical message seen in the Tivoli Enterprise Monitoring Server log when an agent attribute file is not installed correctly, leading to the 'Unable to get attribute name' error.

```log
(4320916A.0049-F60:kfaottev.c,1572,"Translate_ResultBuffer") \n  Unable to get attribute name for tablename/column \n  <UAG524400.UA4>. Ignored.
```

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

### Example Image GET Request

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.4?topic=mvi-disabling-vmware-tools-time-synchronization-windows-vm-deployments

This is an example of a GET request for a specific image using its ID.

```shell
https://<cloud_pak_system>/deployment/resources/images/6557fc7b-388d-422a-92a0-8c95d3fa6052
```

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

### start

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=patterns-classic-virtual-system-instances

Starts the classic virtual system instance.

```APIDOC
## start()

### Description
Starts the classic virtual system instance.

### Method
`start`
```

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

### Start a Specific Virtual Machine Instance

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=machines-virtual-start

This example demonstrates how to start a virtual machine by referencing its index in the virtual machines list. This is useful for managing multiple virtual machine instances.

```bash
admin.virtualmachines[0].start()
```

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

### GET /resources/version Example

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=management-version

This snippet shows an example of a GET request to the /resources/version endpoint and the JSON response indicating the system version.

```json
{
"version": "3.0.0.0-32058"
}
```

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

### Example: Prepare Backup Directory on Standby VM

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=migration-db2-workload

Example commands to log in to a standby VM and create a Db2 backup directory.

```bash
# ssh root@xxx.xxx.xxx.xxx
$ su - db2inst1
$ mkdir /db2data/db2backup
```

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

### Example Log Entry for 'Unable to get attribute name' Error

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=st-general-situation-problems-1

This log entry illustrates a typical error message seen in the Tivoli Enterprise Monitoring Server log when an agent attribute file is not installed correctly, preventing the retrieval of attribute names for situations.

```log
(4320916A.0049-F60:kfaottev.c,1572,"Translate_ResultBuffer") \n  Unable to get attribute name for tablename / \n  <UAG524400.UA4>. Ignored.
```

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

### Example: Accessing VM Configurations

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=cg-cloud-groups-list-virtual-machine-configurations

This example demonstrates how to access the virtual machine configurations for the first cloud object in the list.

```javascript
admin.clouds[0].vmconfigurations
```

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

### Example Error Message in Maintenance Logs

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=tbs-cloud-pak-system-tries-install-already-installed-websphere-portal-server-fix-pack-1

This is an example of an error message that may appear in the maintenance logs when the installation issue occurs. It indicates that the selected fix pack is already installed or a newer version is present.

```text
Invalid CF Selected. The instance is at the selected level or higher. 
Pattern does not support downgrade. Selected fixpack is: CF15 for v8.5 and v9.0. 
Currently running version is: CF15 for v8.5 and v9.0.
```

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

### start

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=management-virtual-machines

Starts a virtual machine.

```APIDOC
## start()

### Description
Starts a virtual machine.

### Method
Not specified (assumed to be a method call on a VirtualMachine object)

### Endpoint
Not applicable (SDK method)

### Parameters
None.

### Request Example
```python
vm.start()
```

### Response
Details not provided in the source.
```

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

### Create a virtual system using the wizard with pattern selection

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=methods-wizard-objects-command-line-interface

Demonstrates creating a virtual system, including selecting a pattern from a list by entering its corresponding number.

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

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

### Endpoint Manager Client Firewall and Startup Log Example

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.4?topic=temc-troubleshooting-clients-by-using-logs-endpoint-manager-console

This log excerpt details the firewall configuration for the Endpoint Manager client, including accepted TCP and ICMP connections. It also shows the process of finding the shared service IP, installing the client, pulling the masthead, and starting the client service.

```log
[Fri 05 Apr 2013 01:49:54 PM UTC] firewall.py 140530285713152 pid=11787 DEBUG ACCEPT  tcp opt -- in * out eth0  0.0.0.0/0  -> 0.0.0.0/0  tcp dpt:52311
ACCEPT  tcp opt -- in eth0 out *  0.0.0.0/0  -> 0.0.0.0/0  tcp spt:52311

[Fri 05 Apr 2013 01:49:54 PM UTC] firewall.py 140530285713152 pid=11787 DEBUG ACCEPT  tcp opt -- in eth0 out *  0.0.0.0/0  -> 0.0.0.0/0  tcp dpt:52311
ACCEPT  tcp opt -- in * out eth0  0.0.0.0/0  -> 0.0.0.0/0  tcp spt:52311

[Fri 05 Apr 2013 01:49:54 PM UTC] firewall.py 140530285713152 pid=11787 DEBUG ACCEPT  icmp opt -- in eth0 out *  0.0.0.0/0  -> 0.0.0.0/0

[Fri 05 Apr 2013 01:49:54 PM UTC] firewall.py 140530285713152 pid=11787 DEBUG ACCEPT  icmp opt -- in * out eth0  0.0.0.0/0  -> 0.0.0.0/0

[Fri 05 Apr 2013 01:49:55 PM UTC] firewall.py 140530285713152 pid=11787 DEBUG ACCEPT  udp opt -- in eth0 out *  0.0.0.0/0  -> 0.0.0.0/0

[Fri 05 Apr 2013 01:49:55 PM UTC] firewall.py 140530285713152 pid=11787 DEBUG ACCEPT  udp opt -- in * out eth0  0.0.0.0/0  -> 0.0.0.0/0

	Finding the IBM Endpoint Manager Shared Service deployment IP address:

[Fri 05 Apr 2013 01:50:06 PM UTC] TEMCLIENT/tem_agent_task.py 139912058787584 pid=12065 DEBUG Found IBM Endpoint Manager ip in the registry 172.16.84.129

	Installing the IBM Endpoint Manager client:

[Fri 05 Apr 2013 01:50:06 PM UTC] TEMCLIENT/tem_agent_task.py 139912058787584 pid=12065 DEBUG IBM Endpoint Manager Client preparing install !!
[Fri 05 Apr 2013 01:50:12 PM UTC] TEMCLIENT/tem_agent_task.py 139912058787584 pid=12065 DEBUG Preparing...                ################################
##################
BESAgent                    ##################################################

	Pulling the masthead file from the  IBM Endpoint Manager Shared Service:

[Fri 05 Apr 2013 01:50:12 PM UTC] TEMCLIENT/tem_agent_task.py 139912058787584 pid=12065 DEBUG pcurl use url : https://172.16.84.129:9999/sharedservice/IBM
EndpointManager/getMasthead
[Fri 05 Apr 2013 01:50:12 PM UTC] TEMCLIENT/tem_agent_task.py 139912058787584 pid=12065 DEBUG pcurl invoke command  return code: 0

	Starting the IBM Endpoint Manager client:

[Fri 05 Apr 2013 01:50:12 PM UTC] TEMCLIENT/tem_agent_task.[  OK  12058787584 pid=12065 DEBUG Starting IBM Endpoint Manager: BESClient:
]

[Fri 05 Apr 2013 01:50:12 PM UTC] TEMCLIENT/tem_agent_task.py 139912058787584 pid=12065 DEBUG IBM Endpoint Manager installed and started !!
```

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

### Start a Virtual Machine

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.5?topic=machines-virtual-start

Use this command to initiate the startup process for a virtual machine. Ensure the virtual machine is properly configured before attempting to start.

```bash
virtualmachine.start()
```

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

### Install Pattern Type for Specific Product (IWD)

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=oco-product-specific-settings

Specify that a pattern type is only installed for a specific product by setting the 'products' value in patterntype.json. This example ensures installation only for IWD.

```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"]
    },
}
```

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

### Create Virtual System with Pattern Selection

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=rrcm-wizard-objects-command-line-interface

Demonstrates creating a virtual system using the wizard, including selecting a pattern from a list. Use '*' to see the list of available patterns.

```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: List Volume Configurations

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=cg-cloud-groups-list-volume-configurations

This example shows how to retrieve volume configurations for the first cloud object in the administration context.

```javascript
admin.clouds[0].volumeconfigurations
```

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

### POST /resources/virtualSystems Example

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.4?topic=management-classic-virtual-system-instances

This snippet demonstrates the structure of a request to create a new virtual system instance. It includes details about the instance's configuration, such as virtual CPUs, memory, node name, and credentials.

```APIDOC
## POST /resources/virtualSystems

### Description
Creates a new classic virtual system instance with specified configurations.

### Method
POST

### Endpoint
/resources/virtualSystems

### Request Body
- **id** (integer) - Required - The ID for the new instance.
- **label** (string) - Required - A descriptive label for the instance.
- **nics** (array) - Required - Network interface configurations.
- **properties** (array) - Required - Hardware and configuration properties for the instance.
  - **description** (string) - Description of the property.
  - **key** (string) - The key identifier for the property.
  - **label** (string) - The display label for the property.
  - **pclass** (string) - The property class.
  - **type** (string) - The data type of the property.
  - **validValues** (array) - Optional - Allowed values for the property.
  - **value** (string) - The value of the property.
- **scripts** (array) - Optional - Scripts to be executed on the instance.
- **virtualimage** (string) - Required - The virtual image to use for the instance.
- **pattern** (string) - Required - The pattern to use for the instance.

### Request Example
```json
{
    "id":3,
    "label":"Custom nodes",
    "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 node name of the profile",
            "key":"node_name",
            "label":"Node name",
            "pclass":"ConfigWAS",
            "type":"string",
            "value":"CloudBurstNode"
        },
        {
            "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":[
        
    ],
    "virtualimage":"\/resources\/virtualImages\/1"
}
```

### Response
#### Success Response (200)
- **created** (integer) - Timestamp when the instance was created.
- **currentmessage** (string) - Current message related to the instance status.
- **currentmessage_text** (string) - Textual representation of the current message.
- **currentstatus** (string) - The current operational status of the instance.
- **currentstatus_text** (string) - Textual representation of the current status.
- **desiredstatus** (string) - The desired operational status of the instance.
- **desiredstatus_text** (string) - Textual representation of the desired status.
- **id** (integer) - The unique identifier of the instance.
- **name** (string) - The name of the instance.
- **owner** (string) - The resource path of the user who owns the instance.
- **pattern** (string) - The resource path of the pattern used for the instance.
- **updated** (integer) - Timestamp when the instance was last updated.

#### Response Example
```json
{
   "created": 1245361773378,
   "currentmessage": null,
   "currentmessage_text": null,
   "currentstatus": "RM01036",
   "currentstatus_text": "Queued",
   "desiredstatus": "",
   "desiredstatus_text": null,
   "id": 13,
   "name": "sample virtual system instance",
   "owner": "\/resources\/users\/1",
   "pattern": "\/resources\/patterns\/1",
   "updated": 1245361773378
}
```
```

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

### Example: Get ACL for a Specific User

Source: https://www.ibm.com/docs/en/cloud-pak-system-software/2.3.3?topic=a-acl-get-given-user-group

This example demonstrates retrieving the ACL for a specific user within the first cloud resource.

```shell
>>>admin.clouds[0].acl[admin.users[0]]
```
Tokens:
Raw