Q2 Release 2024

.github/workflows/go.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-
+      
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
@@ -39,4 +39,4 @@ jobs:
         run: go test -v `go list ./... | grep -v '/power/' | grep -v examples`
 
       - name: Coverage
-        run: go test `go list ./... | grep -v '/power/' | grep -v examples` -coverprofile=profile.cov && go tool cover -func profile.cov
+        run: go test `go list ./... | grep -v '/power/' | grep -v examples` -coverprofile=profile.cov && go tool cover -func profile.cov

clients/instance/ibm-pi-host-groups.go

@@ -0,0 +1,193 @@
+package instance
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/IBM-Cloud/power-go-client/helpers"
+	"github.com/IBM-Cloud/power-go-client/ibmpisession"
+	"github.com/IBM-Cloud/power-go-client/power/client/host_groups"
+	"github.com/IBM-Cloud/power-go-client/power/models"
+)
+
+// IBMPIHostGroupsClient
+type IBMPIHostGroupsClient struct {
+	IBMPIClient
+}
+
+// NewIBMPIHostGroupsClient
+func NewIBMPIHostGroupsClient(ctx context.Context, sess *ibmpisession.IBMPISession, cloudInstanceID string) *IBMPIHostGroupsClient {
+	return &IBMPIHostGroupsClient{
+		*NewIBMPIClient(ctx, sess, cloudInstanceID),
+	}
+}
+
+// Get All available hosts
+func (f *IBMPIHostGroupsClient) GetAvailableHosts() (models.AvailableHostList, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1AvailableHostsParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut)
+	resp, err := f.session.Power.HostGroups.V1AvailableHosts(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to Get available hosts for %s: %w", f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to get available hosts")
+	}
+	return resp.Payload, nil
+}
+
+// Get all host groups
+func (f *IBMPIHostGroupsClient) GetHostGroups() (models.HostGroupList, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostGroupsGetParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut)
+	resp, err := f.session.Power.HostGroups.V1HostGroupsGet(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to get Host groups for %s: %w", f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to get host groups")
+	}
+	return resp.Payload, nil
+}
+
+// Create a host group
+func (f *IBMPIHostGroupsClient) CreateHostGroup(body *models.HostGroupCreate) (*models.HostGroup, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostGroupsPostParams().WithContext(f.ctx).WithTimeout(helpers.PICreateTimeOut).WithBody(body)
+	resp, err := f.session.Power.HostGroups.V1HostGroupsPost(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to create host group for %s: %w", f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to create host groups")
+	}
+	return resp.Payload, nil
+}
+
+// Update a host group
+func (f *IBMPIHostGroupsClient) UpdateHostGroup(body *models.HostGroupShareOp, id string) (*models.HostGroup, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostGroupsIDPutParams().WithContext(f.ctx).WithTimeout(helpers.PICreateTimeOut).WithBody(body).WithHostGroupID(id)
+	resp, err := f.session.Power.HostGroups.V1HostGroupsIDPut(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to update host group for %s: %w", f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to update host groups")
+	}
+	return resp.Payload, nil
+}
+
+// Get a host group
+func (f *IBMPIHostGroupsClient) GetHostGroup(id string) (*models.HostGroup, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostGroupsIDGetParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).WithHostGroupID(id)
+	resp, err := f.session.Power.HostGroups.V1HostGroupsIDGet(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to get host group %s for %s: %w", id, f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to get host group %s", id)
+	}
+	return resp.Payload, nil
+}
+
+// Get  all hosts
+func (f *IBMPIHostGroupsClient) GetHosts() (models.HostList, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostsGetParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut)
+	resp, err := f.session.Power.HostGroups.V1HostsGet(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to get hosts for %s: %w", f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to get hosts")
+	}
+	return resp.Payload, nil
+}
+
+// Create a host
+func (f *IBMPIHostGroupsClient) CreateHost(body *models.HostCreate) (models.HostList, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostsPostParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).WithBody(body)
+	resp, err := f.session.Power.HostGroups.V1HostsPost(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to create a host for %s: %w", f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to create a host")
+	}
+	return resp.Payload, nil
+}
+
+// Get a host
+func (f *IBMPIHostGroupsClient) GetHost(id string) (*models.Host, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostsIDGetParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).WithHostID(id)
+	resp, err := f.session.Power.HostGroups.V1HostsIDGet(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to get host %s for %s: %w", id, f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to get host %s", id)
+	}
+	return resp.Payload, nil
+}
+
+// Update a host
+func (f *IBMPIHostGroupsClient) UpdateHost(body *models.HostPut, id string) (*models.Host, error) {
+	if f.session.IsOnPrem() {
+		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostsIDPutParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).WithHostID(id).WithBody(body)
+	resp, err := f.session.Power.HostGroups.V1HostsIDPut(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return nil, ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to update host %s for %s: %w", id, f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return nil, fmt.Errorf("failed to update host %s", id)
+	}
+	return resp.Payload, nil
+}
+
+// Delete a host
+func (f *IBMPIHostGroupsClient) DeleteHost(id string) error {
+	if f.session.IsOnPrem() {
+		return fmt.Errorf("operation not supported in satellite location, check documentation")
+	}
+	params := host_groups.NewV1HostsIDDeleteParams().WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).WithHostID(id)
+	resp, err := f.session.Power.HostGroups.V1HostsIDDelete(params, f.session.AuthInfo(f.cloudInstanceID))
+	if err != nil {
+		return ibmpisession.SDKFailWithAPIError(err, fmt.Errorf("failed to delete host %s for %s: %w", id, f.cloudInstanceID, err))
+	}
+
+	if resp == nil || resp.Payload == nil {
+		return fmt.Errorf("failed to delete host %s", id)
+	}
+	return nil
+}

clients/instance/ibm-pi-image.go

@@ -79,6 +79,10 @@ func (f *IBMPIImageClient) Create(body *models.CreateImage) (*models.Image, erro
 
 // Import an Image
 func (f *IBMPIImageClient) CreateCosImage(body *models.CreateCosImageImportJob) (imageJob *models.JobReference, err error) {
+	// Check for satellite differences in this endpoint
+	if !f.session.IsOnPrem() && body.Checksum {
+		return nil, fmt.Errorf("checksum parameter is not supported off-premise")
+	}
 	params := p_cloud_images.NewPcloudV1CloudinstancesCosimagesPostParams().
 		WithContext(f.ctx).WithTimeout(helpers.PICreateTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID).WithBody(body)
@@ -94,6 +98,10 @@ func (f *IBMPIImageClient) CreateCosImage(body *models.CreateCosImageImportJob)
 
 // Export an Image
 func (f *IBMPIImageClient) ExportImage(id string, body *models.ExportImage) (*models.JobReference, error) {
+	// Check for satellite differences in this endpoint
+	if !f.session.IsOnPrem() && body.Checksum {
+		return nil, fmt.Errorf("checksum parameter is not supported off-premise")
+	}
 	params := p_cloud_images.NewPcloudV2ImagesExportPostParams().
 		WithContext(f.ctx).WithTimeout(helpers.PICreateTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID).WithImageID(id).WithBody(body)

clients/instance/ibm-pi-instance.go

@@ -55,8 +55,8 @@ func (f *IBMPIInstanceClient) GetAll() (*models.PVMInstances, error) {
 // Create an Instance
 func (f *IBMPIInstanceClient) Create(body *models.PVMInstanceCreate) (*models.PVMInstanceList, error) {
 	// Check for satellite differences in this endpoint
-	if f.session.IsOnPrem() && (body.SoftwareLicenses != nil || body.SharedProcessorPool != "") {
-		return nil, fmt.Errorf("software licenses and shared processor pool parameters are not supported in satellite location, check documentation")
+	if f.session.IsOnPrem() && body.DeploymentTarget != nil {
+		return nil, fmt.Errorf("deployment target parameter is not supported in satellite location, check documentation")
 	}
 	params := p_cloud_p_vm_instances.NewPcloudPvminstancesPostParams().
 		WithContext(f.ctx).WithTimeout(helpers.PICreateTimeOut).
@@ -176,6 +176,10 @@ func (f *IBMPIInstanceClient) UpdateConsoleLanguage(id string, body *models.Cons
 
 // Capture an Instance
 func (f *IBMPIInstanceClient) CaptureInstanceToImageCatalog(id string, body *models.PVMInstanceCapture) error {
+	// Check for satellite differences in this endpoint
+	if !f.session.IsOnPrem() && body.Checksum {
+		return fmt.Errorf("checksum parameter is not supported off-premise")
+	}
 	params := p_cloud_p_vm_instances.NewPcloudPvminstancesCapturePostParams().
 		WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID).WithPvmInstanceID(id).

clients/instance/ibm-pi-shared-processor-pool.go

@@ -26,9 +26,6 @@ func NewIBMPISharedProcessorPoolClient(ctx context.Context, sess *ibmpisession.I
 
 // Get a PI Shared Processor Pool
 func (f *IBMPISharedProcessorPoolClient) Get(id string) (*models.SharedProcessorPoolDetail, error) {
-	if f.session.IsOnPrem() {
-		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
-	}
 	params := p_cloud_shared_processor_pools.NewPcloudSharedprocessorpoolsGetParams().
 		WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID).WithSharedProcessorPoolID(id)
@@ -44,9 +41,6 @@ func (f *IBMPISharedProcessorPoolClient) Get(id string) (*models.SharedProcessor
 
 // Get All Shared Processor Pools
 func (f *IBMPISharedProcessorPoolClient) GetAll() (*models.SharedProcessorPools, error) {
-	if f.session.IsOnPrem() {
-		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
-	}
 	params := p_cloud_shared_processor_pools.NewPcloudSharedprocessorpoolsGetallParams().
 		WithContext(f.ctx).WithTimeout(helpers.PIGetTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID)
@@ -62,8 +56,9 @@ func (f *IBMPISharedProcessorPoolClient) GetAll() (*models.SharedProcessorPools,
 
 // Create a Shared Processor Pool
 func (f *IBMPISharedProcessorPoolClient) Create(body *models.SharedProcessorPoolCreate) (*models.SharedProcessorPool, error) {
-	if f.session.IsOnPrem() {
-		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
+	// Check for satellite differences in this endpoint
+	if f.session.IsOnPrem() && body.HostID != "" {
+		return nil, fmt.Errorf("host id parameter is not supported in satellite location, check documentation")
 	}
 	params := p_cloud_shared_processor_pools.NewPcloudSharedprocessorpoolsPostParams().
 		WithContext(f.ctx).WithTimeout(helpers.PICreateTimeOut).
@@ -80,9 +75,6 @@ func (f *IBMPISharedProcessorPoolClient) Create(body *models.SharedProcessorPool
 
 // Delete a Shared Processor Pool
 func (f *IBMPISharedProcessorPoolClient) Delete(id string) error {
-	if f.session.IsOnPrem() {
-		return fmt.Errorf("operation not supported in satellite location, check documentation")
-	}
 	params := p_cloud_shared_processor_pools.NewPcloudSharedprocessorpoolsDeleteParams().
 		WithContext(f.ctx).WithTimeout(helpers.PIDeleteTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID).WithSharedProcessorPoolID(id)
@@ -95,9 +87,6 @@ func (f *IBMPISharedProcessorPoolClient) Delete(id string) error {
 
 // Update a PI Shared Processor Pool
 func (f *IBMPISharedProcessorPoolClient) Update(id string, body *models.SharedProcessorPoolUpdate) (*models.SharedProcessorPool, error) {
-	if f.session.IsOnPrem() {
-		return nil, fmt.Errorf("operation not supported in satellite location, check documentation")
-	}
 	params := p_cloud_shared_processor_pools.NewPcloudSharedprocessorpoolsPutParams().
 		WithContext(f.ctx).WithTimeout(helpers.PIUpdateTimeOut).
 		WithCloudInstanceID(f.cloudInstanceID).WithBody(body).WithSharedProcessorPoolID(id)

examples/host-groups/main.go

@@ -0,0 +1,62 @@
+package main
+
+import (
+	"context"
+	"log"
+
+	v "github.com/IBM-Cloud/power-go-client/clients/instance"
+	ps "github.com/IBM-Cloud/power-go-client/ibmpisession"
+	"github.com/IBM/go-sdk-core/v5/core"
+)
+
+func main() {
+	//session Inputs
+	//  < IAM TOKEN >
+	// token := ""
+	apiKey := ""
+	region := " < REGION > "
+	zone := " < ZONE > "
+	accountID := " < ACCOUNT ID > "
+	url := region + ".power-iaas.test.cloud.ibm.com"
+
+	// dr location inputs
+	piID := " < POWER INSTANCE ID > "
+
+	// authenticator := &core.BearerTokenAuthenticator{
+	// 	BearerToken: token,
+	// }
+	authenticator := &core.IamAuthenticator{
+		ApiKey: apiKey,
+		// Uncomment for test environment
+		URL: "https://iam.test.cloud.ibm.com",
+	}
+
+	// Create the session
+	options := &ps.IBMPIOptions{
+		Authenticator: authenticator,
+		UserAccount:   accountID,
+		Zone:          zone,
+		URL:           url,
+		Debug:         true,
+	}
+	session, err := ps.NewIBMPISession(options)
+	if err != nil {
+		log.Fatal(err)
+	}
+	powerClient := v.NewIBMPIHostGroupsClient(context.Background(), session, piID)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	getAllAvailableHost, err := powerClient.GetAvailableHosts()
+	if err != nil {
+		log.Fatal(err)
+	}
+	log.Printf("***************[0]****************** %+v \n", getAllAvailableHost)
+
+	getHostGroups, err := powerClient.GetHostGroups()
+	if err != nil {
+		log.Fatal(err)
+	}
+	log.Printf("***************[1]****************** %+v \n", getHostGroups)
+}