Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. PiInstance
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.PiInstance

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, delete or update a Power Systems Virtual Server instance.

    Example Usage

    The following example creates a Power Systems Virtual Server instance.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const test_instance = new ibm.PiInstance("test-instance", {
    piMemory: 4,
    piProcessors: 2,
    piInstanceName: "test-vm",
    piProcType: "shared",
    piImageId: data.ibm_pi_image.powerimages.id,
    piKeyPairName: ibm_pi_key.key.key_id,
    piSysType: "s922",
    piCloudInstanceId: "51e1879c-bcbe-4ee1-a008-49cdba0eaf60",
    piPinPolicy: "none",
    piHealthStatus: "WARNING",
    piNetworks: [{
        networkId: data.ibm_pi_public_network.dsnetwork.id,
    }],
});

    import pulumi
import pulumi_ibm as ibm

test_instance = ibm.PiInstance("test-instance",
    pi_memory=4,
    pi_processors=2,
    pi_instance_name="test-vm",
    pi_proc_type="shared",
    pi_image_id=data["ibm_pi_image"]["powerimages"]["id"],
    pi_key_pair_name=ibm_pi_key["key"]["key_id"],
    pi_sys_type="s922",
    pi_cloud_instance_id="51e1879c-bcbe-4ee1-a008-49cdba0eaf60",
    pi_pin_policy="none",
    pi_health_status="WARNING",
    pi_networks=[{
        "network_id": data["ibm_pi_public_network"]["dsnetwork"]["id"],
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewPiInstance(ctx, "test-instance", &ibm.PiInstanceArgs{
			PiMemory:          pulumi.Float64(4),
			PiProcessors:      pulumi.Float64(2),
			PiInstanceName:    pulumi.String("test-vm"),
			PiProcType:        pulumi.String("shared"),
			PiImageId:         pulumi.Any(data.Ibm_pi_image.Powerimages.Id),
			PiKeyPairName:     pulumi.Any(ibm_pi_key.Key.Key_id),
			PiSysType:         pulumi.String("s922"),
			PiCloudInstanceId: pulumi.String("51e1879c-bcbe-4ee1-a008-49cdba0eaf60"),
			PiPinPolicy:       pulumi.String("none"),
			PiHealthStatus:    pulumi.String("WARNING"),
			PiNetworks: ibm.PiInstancePiNetworkArray{
				&ibm.PiInstancePiNetworkArgs{
					NetworkId: pulumi.Any(data.Ibm_pi_public_network.Dsnetwork.Id),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var test_instance = new Ibm.PiInstance("test-instance", new()
    {
        PiMemory = 4,
        PiProcessors = 2,
        PiInstanceName = "test-vm",
        PiProcType = "shared",
        PiImageId = data.Ibm_pi_image.Powerimages.Id,
        PiKeyPairName = ibm_pi_key.Key.Key_id,
        PiSysType = "s922",
        PiCloudInstanceId = "51e1879c-bcbe-4ee1-a008-49cdba0eaf60",
        PiPinPolicy = "none",
        PiHealthStatus = "WARNING",
        PiNetworks = new[]
        {
            new Ibm.Inputs.PiInstancePiNetworkArgs
            {
                NetworkId = data.Ibm_pi_public_network.Dsnetwork.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiInstance;
import com.pulumi.ibm.PiInstanceArgs;
import com.pulumi.ibm.inputs.PiInstancePiNetworkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test_instance = new PiInstance("test-instance", PiInstanceArgs.builder()
            .piMemory("4")
            .piProcessors("2")
            .piInstanceName("test-vm")
            .piProcType("shared")
            .piImageId(data.ibm_pi_image().powerimages().id())
            .piKeyPairName(ibm_pi_key.key().key_id())
            .piSysType("s922")
            .piCloudInstanceId("51e1879c-bcbe-4ee1-a008-49cdba0eaf60")
            .piPinPolicy("none")
            .piHealthStatus("WARNING")
            .piNetworks(PiInstancePiNetworkArgs.builder()
                .networkId(data.ibm_pi_public_network().dsnetwork().id())
                .build())
            .build());

    }
}

    resources:
  test-instance:
    type: ibm:PiInstance
    properties:
      piMemory: '4'
      piProcessors: '2'
      piInstanceName: test-vm
      piProcType: shared
      piImageId: ${data.ibm_pi_image.powerimages.id}
      piKeyPairName: ${ibm_pi_key.key.key_id}
      piSysType: s922
      piCloudInstanceId: 51e1879c-bcbe-4ee1-a008-49cdba0eaf60
      piPinPolicy: none
      piHealthStatus: WARNING
      piNetworks:
        - networkId: ${data.ibm_pi_public_network.dsnetwork.id}

    WARNING: Updating a ibm.PiInstance resource with pi_replicants set does not update replicant vms!

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

    import * as pulumi from "@pulumi/pulumi";

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

    {}

    Create PiInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PiInstance(name: string, args: PiInstanceArgs, opts?: CustomResourceOptions);
    @overload
def PiInstance(resource_name: str,
               args: PiInstanceArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def PiInstance(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               pi_cloud_instance_id: Optional[str] = None,
               pi_networks: Optional[Sequence[PiInstancePiNetworkArgs]] = None,
               pi_instance_name: Optional[str] = None,
               pi_image_id: Optional[str] = None,
               pi_proc_type: Optional[str] = None,
               pi_memory: Optional[float] = None,
               pi_anti_affinity_volumes: Optional[Sequence[str]] = None,
               pi_deployment_target: Optional[PiInstancePiDeploymentTargetArgs] = None,
               pi_deployment_type: Optional[str] = None,
               pi_health_status: Optional[str] = None,
               pi_ibmi_css: Optional[bool] = None,
               pi_ibmi_pha: Optional[bool] = None,
               pi_ibmi_rds_users: Optional[float] = None,
               pi_anti_affinity_instances: Optional[Sequence[str]] = None,
               pi_instance_id: Optional[str] = None,
               pi_affinity_volume: Optional[str] = None,
               pi_key_pair_name: Optional[str] = None,
               pi_license_repository_capacity: Optional[float] = None,
               pi_processors: Optional[float] = None,
               pi_affinity_policy: Optional[str] = None,
               pi_pin_policy: Optional[str] = None,
               pi_placement_group_id: Optional[str] = None,
               pi_boot_volume_replication_enabled: Optional[bool] = None,
               pi_affinity_instance: Optional[str] = None,
               pi_sap_deployment_type: Optional[str] = None,
               pi_replication_policy: Optional[str] = None,
               pi_replication_scheme: Optional[str] = None,
               pi_replication_sites: Optional[Sequence[str]] = None,
               pi_retain_virtual_serial_number: Optional[bool] = None,
               pi_replicants: Optional[float] = None,
               pi_sap_profile_id: Optional[str] = None,
               pi_shared_processor_pool: Optional[str] = None,
               pi_storage_connection: Optional[str] = None,
               pi_storage_pool: Optional[str] = None,
               pi_storage_pool_affinity: Optional[bool] = None,
               pi_storage_type: Optional[str] = None,
               pi_sys_type: Optional[str] = None,
               pi_user_data: Optional[str] = None,
               pi_user_tags: Optional[Sequence[str]] = None,
               pi_virtual_cores_assigned: Optional[float] = None,
               pi_virtual_optical_device: Optional[str] = None,
               pi_virtual_serial_number: Optional[PiInstancePiVirtualSerialNumberArgs] = None,
               pi_volume_ids: Optional[Sequence[str]] = None,
               timeouts: Optional[PiInstanceTimeoutsArgs] = None)
    func NewPiInstance(ctx *Context, name string, args PiInstanceArgs, opts ...ResourceOption) (*PiInstance, error)
    public PiInstance(string name, PiInstanceArgs args, CustomResourceOptions? opts = null)
    public PiInstance(String name, PiInstanceArgs args)
public PiInstance(String name, PiInstanceArgs args, CustomResourceOptions options)

    type: ibm:PiInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PiInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PiInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PiInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var piInstanceResource = new Ibm.PiInstance("piInstanceResource", new()
{
    PiCloudInstanceId = "string",
    PiNetworks = new[]
    {
        new Ibm.Inputs.PiInstancePiNetworkArgs
        {
            NetworkId = "string",
            ExternalIp = "string",
            IpAddress = "string",
            MacAddress = "string",
            NetworkInterfaceId = "string",
            NetworkName = "string",
            NetworkSecurityGroupIds = new[]
            {
                "string",
            },
            NetworkSecurityGroupsHreves = new[]
            {
                "string",
            },
            Type = "string",
        },
    },
    PiInstanceName = "string",
    PiImageId = "string",
    PiProcType = "string",
    PiMemory = 0,
    PiAntiAffinityVolumes = new[]
    {
        "string",
    },
    PiDeploymentTarget = new Ibm.Inputs.PiInstancePiDeploymentTargetArgs
    {
        Id = "string",
        Type = "string",
    },
    PiDeploymentType = "string",
    PiHealthStatus = "string",
    PiIbmiCss = false,
    PiIbmiPha = false,
    PiIbmiRdsUsers = 0,
    PiAntiAffinityInstances = new[]
    {
        "string",
    },
    PiInstanceId = "string",
    PiAffinityVolume = "string",
    PiKeyPairName = "string",
    PiLicenseRepositoryCapacity = 0,
    PiProcessors = 0,
    PiAffinityPolicy = "string",
    PiPinPolicy = "string",
    PiPlacementGroupId = "string",
    PiBootVolumeReplicationEnabled = false,
    PiAffinityInstance = "string",
    PiSapDeploymentType = "string",
    PiReplicationPolicy = "string",
    PiReplicationScheme = "string",
    PiReplicationSites = new[]
    {
        "string",
    },
    PiRetainVirtualSerialNumber = false,
    PiReplicants = 0,
    PiSapProfileId = "string",
    PiSharedProcessorPool = "string",
    PiStorageConnection = "string",
    PiStoragePool = "string",
    PiStoragePoolAffinity = false,
    PiStorageType = "string",
    PiSysType = "string",
    PiUserData = "string",
    PiUserTags = new[]
    {
        "string",
    },
    PiVirtualCoresAssigned = 0,
    PiVirtualOpticalDevice = "string",
    PiVirtualSerialNumber = new Ibm.Inputs.PiInstancePiVirtualSerialNumberArgs
    {
        Serial = "string",
        Description = "string",
    },
    PiVolumeIds = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.PiInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewPiInstance(ctx, "piInstanceResource", &ibm.PiInstanceArgs{
	PiCloudInstanceId: pulumi.String("string"),
	PiNetworks: ibm.PiInstancePiNetworkArray{
		&ibm.PiInstancePiNetworkArgs{
			NetworkId:          pulumi.String("string"),
			ExternalIp:         pulumi.String("string"),
			IpAddress:          pulumi.String("string"),
			MacAddress:         pulumi.String("string"),
			NetworkInterfaceId: pulumi.String("string"),
			NetworkName:        pulumi.String("string"),
			NetworkSecurityGroupIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			NetworkSecurityGroupsHreves: pulumi.StringArray{
				pulumi.String("string"),
			},
			Type: pulumi.String("string"),
		},
	},
	PiInstanceName: pulumi.String("string"),
	PiImageId:      pulumi.String("string"),
	PiProcType:     pulumi.String("string"),
	PiMemory:       pulumi.Float64(0),
	PiAntiAffinityVolumes: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiDeploymentTarget: &ibm.PiInstancePiDeploymentTargetArgs{
		Id:   pulumi.String("string"),
		Type: pulumi.String("string"),
	},
	PiDeploymentType: pulumi.String("string"),
	PiHealthStatus:   pulumi.String("string"),
	PiIbmiCss:        pulumi.Bool(false),
	PiIbmiPha:        pulumi.Bool(false),
	PiIbmiRdsUsers:   pulumi.Float64(0),
	PiAntiAffinityInstances: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiInstanceId:                   pulumi.String("string"),
	PiAffinityVolume:               pulumi.String("string"),
	PiKeyPairName:                  pulumi.String("string"),
	PiLicenseRepositoryCapacity:    pulumi.Float64(0),
	PiProcessors:                   pulumi.Float64(0),
	PiAffinityPolicy:               pulumi.String("string"),
	PiPinPolicy:                    pulumi.String("string"),
	PiPlacementGroupId:             pulumi.String("string"),
	PiBootVolumeReplicationEnabled: pulumi.Bool(false),
	PiAffinityInstance:             pulumi.String("string"),
	PiSapDeploymentType:            pulumi.String("string"),
	PiReplicationPolicy:            pulumi.String("string"),
	PiReplicationScheme:            pulumi.String("string"),
	PiReplicationSites: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiRetainVirtualSerialNumber: pulumi.Bool(false),
	PiReplicants:                pulumi.Float64(0),
	PiSapProfileId:              pulumi.String("string"),
	PiSharedProcessorPool:       pulumi.String("string"),
	PiStorageConnection:         pulumi.String("string"),
	PiStoragePool:               pulumi.String("string"),
	PiStoragePoolAffinity:       pulumi.Bool(false),
	PiStorageType:               pulumi.String("string"),
	PiSysType:                   pulumi.String("string"),
	PiUserData:                  pulumi.String("string"),
	PiUserTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiVirtualCoresAssigned: pulumi.Float64(0),
	PiVirtualOpticalDevice: pulumi.String("string"),
	PiVirtualSerialNumber: &ibm.PiInstancePiVirtualSerialNumberArgs{
		Serial:      pulumi.String("string"),
		Description: pulumi.String("string"),
	},
	PiVolumeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.PiInstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var piInstanceResource = new PiInstance("piInstanceResource", PiInstanceArgs.builder()
    .piCloudInstanceId("string")
    .piNetworks(PiInstancePiNetworkArgs.builder()
        .networkId("string")
        .externalIp("string")
        .ipAddress("string")
        .macAddress("string")
        .networkInterfaceId("string")
        .networkName("string")
        .networkSecurityGroupIds("string")
        .networkSecurityGroupsHreves("string")
        .type("string")
        .build())
    .piInstanceName("string")
    .piImageId("string")
    .piProcType("string")
    .piMemory(0)
    .piAntiAffinityVolumes("string")
    .piDeploymentTarget(PiInstancePiDeploymentTargetArgs.builder()
        .id("string")
        .type("string")
        .build())
    .piDeploymentType("string")
    .piHealthStatus("string")
    .piIbmiCss(false)
    .piIbmiPha(false)
    .piIbmiRdsUsers(0)
    .piAntiAffinityInstances("string")
    .piInstanceId("string")
    .piAffinityVolume("string")
    .piKeyPairName("string")
    .piLicenseRepositoryCapacity(0)
    .piProcessors(0)
    .piAffinityPolicy("string")
    .piPinPolicy("string")
    .piPlacementGroupId("string")
    .piBootVolumeReplicationEnabled(false)
    .piAffinityInstance("string")
    .piSapDeploymentType("string")
    .piReplicationPolicy("string")
    .piReplicationScheme("string")
    .piReplicationSites("string")
    .piRetainVirtualSerialNumber(false)
    .piReplicants(0)
    .piSapProfileId("string")
    .piSharedProcessorPool("string")
    .piStorageConnection("string")
    .piStoragePool("string")
    .piStoragePoolAffinity(false)
    .piStorageType("string")
    .piSysType("string")
    .piUserData("string")
    .piUserTags("string")
    .piVirtualCoresAssigned(0)
    .piVirtualOpticalDevice("string")
    .piVirtualSerialNumber(PiInstancePiVirtualSerialNumberArgs.builder()
        .serial("string")
        .description("string")
        .build())
    .piVolumeIds("string")
    .timeouts(PiInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    pi_instance_resource = ibm.PiInstance("piInstanceResource",
    pi_cloud_instance_id="string",
    pi_networks=[{
        "network_id": "string",
        "external_ip": "string",
        "ip_address": "string",
        "mac_address": "string",
        "network_interface_id": "string",
        "network_name": "string",
        "network_security_group_ids": ["string"],
        "network_security_groups_hreves": ["string"],
        "type": "string",
    }],
    pi_instance_name="string",
    pi_image_id="string",
    pi_proc_type="string",
    pi_memory=0,
    pi_anti_affinity_volumes=["string"],
    pi_deployment_target={
        "id": "string",
        "type": "string",
    },
    pi_deployment_type="string",
    pi_health_status="string",
    pi_ibmi_css=False,
    pi_ibmi_pha=False,
    pi_ibmi_rds_users=0,
    pi_anti_affinity_instances=["string"],
    pi_instance_id="string",
    pi_affinity_volume="string",
    pi_key_pair_name="string",
    pi_license_repository_capacity=0,
    pi_processors=0,
    pi_affinity_policy="string",
    pi_pin_policy="string",
    pi_placement_group_id="string",
    pi_boot_volume_replication_enabled=False,
    pi_affinity_instance="string",
    pi_sap_deployment_type="string",
    pi_replication_policy="string",
    pi_replication_scheme="string",
    pi_replication_sites=["string"],
    pi_retain_virtual_serial_number=False,
    pi_replicants=0,
    pi_sap_profile_id="string",
    pi_shared_processor_pool="string",
    pi_storage_connection="string",
    pi_storage_pool="string",
    pi_storage_pool_affinity=False,
    pi_storage_type="string",
    pi_sys_type="string",
    pi_user_data="string",
    pi_user_tags=["string"],
    pi_virtual_cores_assigned=0,
    pi_virtual_optical_device="string",
    pi_virtual_serial_number={
        "serial": "string",
        "description": "string",
    },
    pi_volume_ids=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const piInstanceResource = new ibm.PiInstance("piInstanceResource", {
    piCloudInstanceId: "string",
    piNetworks: [{
        networkId: "string",
        externalIp: "string",
        ipAddress: "string",
        macAddress: "string",
        networkInterfaceId: "string",
        networkName: "string",
        networkSecurityGroupIds: ["string"],
        networkSecurityGroupsHreves: ["string"],
        type: "string",
    }],
    piInstanceName: "string",
    piImageId: "string",
    piProcType: "string",
    piMemory: 0,
    piAntiAffinityVolumes: ["string"],
    piDeploymentTarget: {
        id: "string",
        type: "string",
    },
    piDeploymentType: "string",
    piHealthStatus: "string",
    piIbmiCss: false,
    piIbmiPha: false,
    piIbmiRdsUsers: 0,
    piAntiAffinityInstances: ["string"],
    piInstanceId: "string",
    piAffinityVolume: "string",
    piKeyPairName: "string",
    piLicenseRepositoryCapacity: 0,
    piProcessors: 0,
    piAffinityPolicy: "string",
    piPinPolicy: "string",
    piPlacementGroupId: "string",
    piBootVolumeReplicationEnabled: false,
    piAffinityInstance: "string",
    piSapDeploymentType: "string",
    piReplicationPolicy: "string",
    piReplicationScheme: "string",
    piReplicationSites: ["string"],
    piRetainVirtualSerialNumber: false,
    piReplicants: 0,
    piSapProfileId: "string",
    piSharedProcessorPool: "string",
    piStorageConnection: "string",
    piStoragePool: "string",
    piStoragePoolAffinity: false,
    piStorageType: "string",
    piSysType: "string",
    piUserData: "string",
    piUserTags: ["string"],
    piVirtualCoresAssigned: 0,
    piVirtualOpticalDevice: "string",
    piVirtualSerialNumber: {
        serial: "string",
        description: "string",
    },
    piVolumeIds: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:PiInstance
properties:
    piAffinityInstance: string
    piAffinityPolicy: string
    piAffinityVolume: string
    piAntiAffinityInstances:
        - string
    piAntiAffinityVolumes:
        - string
    piBootVolumeReplicationEnabled: false
    piCloudInstanceId: string
    piDeploymentTarget:
        id: string
        type: string
    piDeploymentType: string
    piHealthStatus: string
    piIbmiCss: false
    piIbmiPha: false
    piIbmiRdsUsers: 0
    piImageId: string
    piInstanceId: string
    piInstanceName: string
    piKeyPairName: string
    piLicenseRepositoryCapacity: 0
    piMemory: 0
    piNetworks:
        - externalIp: string
          ipAddress: string
          macAddress: string
          networkId: string
          networkInterfaceId: string
          networkName: string
          networkSecurityGroupIds:
            - string
          networkSecurityGroupsHreves:
            - string
          type: string
    piPinPolicy: string
    piPlacementGroupId: string
    piProcType: string
    piProcessors: 0
    piReplicants: 0
    piReplicationPolicy: string
    piReplicationScheme: string
    piReplicationSites:
        - string
    piRetainVirtualSerialNumber: false
    piSapDeploymentType: string
    piSapProfileId: string
    piSharedProcessorPool: string
    piStorageConnection: string
    piStoragePool: string
    piStoragePoolAffinity: false
    piStorageType: string
    piSysType: string
    piUserData: string
    piUserTags:
        - string
    piVirtualCoresAssigned: 0
    piVirtualOpticalDevice: string
    piVirtualSerialNumber:
        description: string
        serial: string
    piVolumeIds:
        - string
    timeouts:
        create: string
        delete: string
        update: string

    PiInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PiInstance resource accepts the following input properties:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiImageId string
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    PiInstanceName string
    The name of the Power Systems Virtual Server instance.
    PiNetworks List<PiInstancePiNetwork>
    List of one or more networks to attach to the instance.
    PiAffinityInstance string
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    PiAffinityVolume string
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances List<string>
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes List<string>
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiBootVolumeReplicationEnabled bool
    Indicates if the boot volume should be replication enabled or not.
    PiDeploymentTarget PiInstancePiDeploymentTarget

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    PiDeploymentType string
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    PiHealthStatus string
    Allow the user to set the status of the lpar so that they can connect to it faster
    PiIbmiCss bool
    IBM i Cloud Storage Solution.
    PiIbmiPha bool
    IBM i Power High Availability.
    PiIbmiRdsUsers double
    IBM i Rational Dev Studio Number of User Licenses.
    PiInstanceId string
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    PiKeyPairName string
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    PiLicenseRepositoryCapacity double
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    PiMemory double
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    PiPinPolicy string
    Pin Policy of the instance
    PiPlacementGroupId string
    Placement group ID
    PiProcType string
    Instance processor type
    PiProcessors double
    Processors count
    PiReplicants double
    PI Instance replicas count
    PiReplicationPolicy string
    Replication policy for the PI Instance
    PiReplicationScheme string
    Replication scheme
    PiReplicationSites List<string>
    Indicates the replication sites of the boot volume.
    PiRetainVirtualSerialNumber bool
    Indicates whether to retain virtual serial number when changed or deleted.
    PiSapDeploymentType string
    Custom SAP Deployment Type Information
    PiSapProfileId string
    SAP Profile ID for the amount of cores and memory
    PiSharedProcessorPool string
    Shared Processor Pool the instance is deployed on
    PiStorageConnection string
    Storage Connectivity Group for server deployment
    PiStoragePool string
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    PiStoragePoolAffinity bool
    Indicates if all volumes attached to the server must reside in the same storage pool
    PiStorageType string
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    PiSysType string
    PI Instance system type
    PiUserData string
    Base64 encoded data to be passed in for invoking a cloud init script
    PiUserTags List<string>
    The user tags attached to this resource.
    PiVirtualCoresAssigned double
    Virtual Cores Assigned to the PVMInstance
    PiVirtualOpticalDevice string
    Virtual Machine's Cloud Initialization Virtual Optical Device
    PiVirtualSerialNumber PiInstancePiVirtualSerialNumber
    Virtual Serial Number information
    PiVolumeIds List<string>
    List of PI volumes
    Timeouts PiInstanceTimeouts
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiImageId string
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    PiInstanceName string
    The name of the Power Systems Virtual Server instance.
    PiNetworks []PiInstancePiNetworkArgs
    List of one or more networks to attach to the instance.
    PiAffinityInstance string
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    PiAffinityVolume string
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances []string
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes []string
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiBootVolumeReplicationEnabled bool
    Indicates if the boot volume should be replication enabled or not.
    PiDeploymentTarget PiInstancePiDeploymentTargetArgs

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    PiDeploymentType string
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    PiHealthStatus string
    Allow the user to set the status of the lpar so that they can connect to it faster
    PiIbmiCss bool
    IBM i Cloud Storage Solution.
    PiIbmiPha bool
    IBM i Power High Availability.
    PiIbmiRdsUsers float64
    IBM i Rational Dev Studio Number of User Licenses.
    PiInstanceId string
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    PiKeyPairName string
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    PiLicenseRepositoryCapacity float64
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    PiMemory float64
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    PiPinPolicy string
    Pin Policy of the instance
    PiPlacementGroupId string
    Placement group ID
    PiProcType string
    Instance processor type
    PiProcessors float64
    Processors count
    PiReplicants float64
    PI Instance replicas count
    PiReplicationPolicy string
    Replication policy for the PI Instance
    PiReplicationScheme string
    Replication scheme
    PiReplicationSites []string
    Indicates the replication sites of the boot volume.
    PiRetainVirtualSerialNumber bool
    Indicates whether to retain virtual serial number when changed or deleted.
    PiSapDeploymentType string
    Custom SAP Deployment Type Information
    PiSapProfileId string
    SAP Profile ID for the amount of cores and memory
    PiSharedProcessorPool string
    Shared Processor Pool the instance is deployed on
    PiStorageConnection string
    Storage Connectivity Group for server deployment
    PiStoragePool string
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    PiStoragePoolAffinity bool
    Indicates if all volumes attached to the server must reside in the same storage pool
    PiStorageType string
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    PiSysType string
    PI Instance system type
    PiUserData string
    Base64 encoded data to be passed in for invoking a cloud init script
    PiUserTags []string
    The user tags attached to this resource.
    PiVirtualCoresAssigned float64
    Virtual Cores Assigned to the PVMInstance
    PiVirtualOpticalDevice string
    Virtual Machine's Cloud Initialization Virtual Optical Device
    PiVirtualSerialNumber PiInstancePiVirtualSerialNumberArgs
    Virtual Serial Number information
    PiVolumeIds []string
    List of PI volumes
    Timeouts PiInstanceTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piImageId String
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    piInstanceName String
    The name of the Power Systems Virtual Server instance.
    piNetworks List<PiInstancePiNetwork>
    List of one or more networks to attach to the instance.
    piAffinityInstance String
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    piAffinityVolume String
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piBootVolumeReplicationEnabled Boolean
    Indicates if the boot volume should be replication enabled or not.
    piDeploymentTarget PiInstancePiDeploymentTarget

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    piDeploymentType String
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    piHealthStatus String
    Allow the user to set the status of the lpar so that they can connect to it faster
    piIbmiCss Boolean
    IBM i Cloud Storage Solution.
    piIbmiPha Boolean
    IBM i Power High Availability.
    piIbmiRdsUsers Double
    IBM i Rational Dev Studio Number of User Licenses.
    piInstanceId String
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    piKeyPairName String
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    piLicenseRepositoryCapacity Double
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    piMemory Double
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    piPinPolicy String
    Pin Policy of the instance
    piPlacementGroupId String
    Placement group ID
    piProcType String
    Instance processor type
    piProcessors Double
    Processors count
    piReplicants Double
    PI Instance replicas count
    piReplicationPolicy String
    Replication policy for the PI Instance
    piReplicationScheme String
    Replication scheme
    piReplicationSites List<String>
    Indicates the replication sites of the boot volume.
    piRetainVirtualSerialNumber Boolean
    Indicates whether to retain virtual serial number when changed or deleted.
    piSapDeploymentType String
    Custom SAP Deployment Type Information
    piSapProfileId String
    SAP Profile ID for the amount of cores and memory
    piSharedProcessorPool String
    Shared Processor Pool the instance is deployed on
    piStorageConnection String
    Storage Connectivity Group for server deployment
    piStoragePool String
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    piStoragePoolAffinity Boolean
    Indicates if all volumes attached to the server must reside in the same storage pool
    piStorageType String
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    piSysType String
    PI Instance system type
    piUserData String
    Base64 encoded data to be passed in for invoking a cloud init script
    piUserTags List<String>
    The user tags attached to this resource.
    piVirtualCoresAssigned Double
    Virtual Cores Assigned to the PVMInstance
    piVirtualOpticalDevice String
    Virtual Machine's Cloud Initialization Virtual Optical Device
    piVirtualSerialNumber PiInstancePiVirtualSerialNumber
    Virtual Serial Number information
    piVolumeIds List<String>
    List of PI volumes
    timeouts PiInstanceTimeouts
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piImageId string
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    piInstanceName string
    The name of the Power Systems Virtual Server instance.
    piNetworks PiInstancePiNetwork[]
    List of one or more networks to attach to the instance.
    piAffinityInstance string
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy string
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    piAffinityVolume string
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances string[]
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes string[]
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piBootVolumeReplicationEnabled boolean
    Indicates if the boot volume should be replication enabled or not.
    piDeploymentTarget PiInstancePiDeploymentTarget

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    piDeploymentType string
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    piHealthStatus string
    Allow the user to set the status of the lpar so that they can connect to it faster
    piIbmiCss boolean
    IBM i Cloud Storage Solution.
    piIbmiPha boolean
    IBM i Power High Availability.
    piIbmiRdsUsers number
    IBM i Rational Dev Studio Number of User Licenses.
    piInstanceId string
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    piKeyPairName string
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    piLicenseRepositoryCapacity number
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    piMemory number
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    piPinPolicy string
    Pin Policy of the instance
    piPlacementGroupId string
    Placement group ID
    piProcType string
    Instance processor type
    piProcessors number
    Processors count
    piReplicants number
    PI Instance replicas count
    piReplicationPolicy string
    Replication policy for the PI Instance
    piReplicationScheme string
    Replication scheme
    piReplicationSites string[]
    Indicates the replication sites of the boot volume.
    piRetainVirtualSerialNumber boolean
    Indicates whether to retain virtual serial number when changed or deleted.
    piSapDeploymentType string
    Custom SAP Deployment Type Information
    piSapProfileId string
    SAP Profile ID for the amount of cores and memory
    piSharedProcessorPool string
    Shared Processor Pool the instance is deployed on
    piStorageConnection string
    Storage Connectivity Group for server deployment
    piStoragePool string
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    piStoragePoolAffinity boolean
    Indicates if all volumes attached to the server must reside in the same storage pool
    piStorageType string
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    piSysType string
    PI Instance system type
    piUserData string
    Base64 encoded data to be passed in for invoking a cloud init script
    piUserTags string[]
    The user tags attached to this resource.
    piVirtualCoresAssigned number
    Virtual Cores Assigned to the PVMInstance
    piVirtualOpticalDevice string
    Virtual Machine's Cloud Initialization Virtual Optical Device
    piVirtualSerialNumber PiInstancePiVirtualSerialNumber
    Virtual Serial Number information
    piVolumeIds string[]
    List of PI volumes
    timeouts PiInstanceTimeouts
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_image_id str
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    pi_instance_name str
    The name of the Power Systems Virtual Server instance.
    pi_networks Sequence[PiInstancePiNetworkArgs]
    List of one or more networks to attach to the instance.
    pi_affinity_instance str
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    pi_affinity_policy str
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    pi_affinity_volume str
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    pi_anti_affinity_instances Sequence[str]
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    pi_anti_affinity_volumes Sequence[str]
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    pi_boot_volume_replication_enabled bool
    Indicates if the boot volume should be replication enabled or not.
    pi_deployment_target PiInstancePiDeploymentTargetArgs

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    pi_deployment_type str
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    pi_health_status str
    Allow the user to set the status of the lpar so that they can connect to it faster
    pi_ibmi_css bool
    IBM i Cloud Storage Solution.
    pi_ibmi_pha bool
    IBM i Power High Availability.
    pi_ibmi_rds_users float
    IBM i Rational Dev Studio Number of User Licenses.
    pi_instance_id str
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    pi_key_pair_name str
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    pi_license_repository_capacity float
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    pi_memory float
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    pi_pin_policy str
    Pin Policy of the instance
    pi_placement_group_id str
    Placement group ID
    pi_proc_type str
    Instance processor type
    pi_processors float
    Processors count
    pi_replicants float
    PI Instance replicas count
    pi_replication_policy str
    Replication policy for the PI Instance
    pi_replication_scheme str
    Replication scheme
    pi_replication_sites Sequence[str]
    Indicates the replication sites of the boot volume.
    pi_retain_virtual_serial_number bool
    Indicates whether to retain virtual serial number when changed or deleted.
    pi_sap_deployment_type str
    Custom SAP Deployment Type Information
    pi_sap_profile_id str
    SAP Profile ID for the amount of cores and memory
    pi_shared_processor_pool str
    Shared Processor Pool the instance is deployed on
    pi_storage_connection str
    Storage Connectivity Group for server deployment
    pi_storage_pool str
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    pi_storage_pool_affinity bool
    Indicates if all volumes attached to the server must reside in the same storage pool
    pi_storage_type str
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    pi_sys_type str
    PI Instance system type
    pi_user_data str
    Base64 encoded data to be passed in for invoking a cloud init script
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    pi_virtual_cores_assigned float
    Virtual Cores Assigned to the PVMInstance
    pi_virtual_optical_device str
    Virtual Machine's Cloud Initialization Virtual Optical Device
    pi_virtual_serial_number PiInstancePiVirtualSerialNumberArgs
    Virtual Serial Number information
    pi_volume_ids Sequence[str]
    List of PI volumes
    timeouts PiInstanceTimeoutsArgs
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piImageId String
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    piInstanceName String
    The name of the Power Systems Virtual Server instance.
    piNetworks List<Property Map>
    List of one or more networks to attach to the instance.
    piAffinityInstance String
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    piAffinityVolume String
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piBootVolumeReplicationEnabled Boolean
    Indicates if the boot volume should be replication enabled or not.
    piDeploymentTarget Property Map

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    piDeploymentType String
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    piHealthStatus String
    Allow the user to set the status of the lpar so that they can connect to it faster
    piIbmiCss Boolean
    IBM i Cloud Storage Solution.
    piIbmiPha Boolean
    IBM i Power High Availability.
    piIbmiRdsUsers Number
    IBM i Rational Dev Studio Number of User Licenses.
    piInstanceId String
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    piKeyPairName String
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    piLicenseRepositoryCapacity Number
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    piMemory Number
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    piPinPolicy String
    Pin Policy of the instance
    piPlacementGroupId String
    Placement group ID
    piProcType String
    Instance processor type
    piProcessors Number
    Processors count
    piReplicants Number
    PI Instance replicas count
    piReplicationPolicy String
    Replication policy for the PI Instance
    piReplicationScheme String
    Replication scheme
    piReplicationSites List<String>
    Indicates the replication sites of the boot volume.
    piRetainVirtualSerialNumber Boolean
    Indicates whether to retain virtual serial number when changed or deleted.
    piSapDeploymentType String
    Custom SAP Deployment Type Information
    piSapProfileId String
    SAP Profile ID for the amount of cores and memory
    piSharedProcessorPool String
    Shared Processor Pool the instance is deployed on
    piStorageConnection String
    Storage Connectivity Group for server deployment
    piStoragePool String
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    piStoragePoolAffinity Boolean
    Indicates if all volumes attached to the server must reside in the same storage pool
    piStorageType String
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    piSysType String
    PI Instance system type
    piUserData String
    Base64 encoded data to be passed in for invoking a cloud init script
    piUserTags List<String>
    The user tags attached to this resource.
    piVirtualCoresAssigned Number
    Virtual Cores Assigned to the PVMInstance
    piVirtualOpticalDevice String
    Virtual Machine's Cloud Initialization Virtual Optical Device
    piVirtualSerialNumber Property Map
    Virtual Serial Number information
    piVolumeIds List<String>
    List of PI volumes
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PiInstance resource produces the following output properties:

    Crn string
    (String) The CRN of this resource.
    DedicatedHostId string
    (String) The dedicated host ID where the shared processor pool resides.
    Fault Dictionary<string, string>
    (Map) Fault information, if any.
    HealthStatus string
    (String) The health status of the VM.
    IbmiRds bool
    (Boolean) IBM i Rational Dev Studio.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    (String) The unique identifier of the instance.
    MaxMemory double
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    MaxProcessors double
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    MaxVirtualCores double
    (Integer) The maximum number of virtual cores.
    MinMemory double
    (Float) The minimum memory that was allocated to the instance.
    MinProcessors double
    (Float) The minimum number of processors that the instance can have.
    MinVirtualCores double
    (Integer) The minimum number of virtual cores.
    OperatingSystem string
    Operating System
    OsType string
    OS Type
    PinPolicy string
    (String) The pinning policy of the instance.
    Progress double
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    SharedProcessorPoolId string
    (String) The ID of the shared processor pool for the instance.
    Status string
    (String) The status of the instance.
    Crn string
    (String) The CRN of this resource.
    DedicatedHostId string
    (String) The dedicated host ID where the shared processor pool resides.
    Fault map[string]string
    (Map) Fault information, if any.
    HealthStatus string
    (String) The health status of the VM.
    IbmiRds bool
    (Boolean) IBM i Rational Dev Studio.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    (String) The unique identifier of the instance.
    MaxMemory float64
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    MaxProcessors float64
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    MaxVirtualCores float64
    (Integer) The maximum number of virtual cores.
    MinMemory float64
    (Float) The minimum memory that was allocated to the instance.
    MinProcessors float64
    (Float) The minimum number of processors that the instance can have.
    MinVirtualCores float64
    (Integer) The minimum number of virtual cores.
    OperatingSystem string
    Operating System
    OsType string
    OS Type
    PinPolicy string
    (String) The pinning policy of the instance.
    Progress float64
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    SharedProcessorPoolId string
    (String) The ID of the shared processor pool for the instance.
    Status string
    (String) The status of the instance.
    crn String
    (String) The CRN of this resource.
    dedicatedHostId String
    (String) The dedicated host ID where the shared processor pool resides.
    fault Map<String,String>
    (Map) Fault information, if any.
    healthStatus String
    (String) The health status of the VM.
    ibmiRds Boolean
    (Boolean) IBM i Rational Dev Studio.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    (String) The unique identifier of the instance.
    maxMemory Double
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    maxProcessors Double
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    maxVirtualCores Double
    (Integer) The maximum number of virtual cores.
    minMemory Double
    (Float) The minimum memory that was allocated to the instance.
    minProcessors Double
    (Float) The minimum number of processors that the instance can have.
    minVirtualCores Double
    (Integer) The minimum number of virtual cores.
    operatingSystem String
    Operating System
    osType String
    OS Type
    pinPolicy String
    (String) The pinning policy of the instance.
    progress Double
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    sharedProcessorPoolId String
    (String) The ID of the shared processor pool for the instance.
    status String
    (String) The status of the instance.
    crn string
    (String) The CRN of this resource.
    dedicatedHostId string
    (String) The dedicated host ID where the shared processor pool resides.
    fault {[key: string]: string}
    (Map) Fault information, if any.
    healthStatus string
    (String) The health status of the VM.
    ibmiRds boolean
    (Boolean) IBM i Rational Dev Studio.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    (String) The unique identifier of the instance.
    maxMemory number
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    maxProcessors number
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    maxVirtualCores number
    (Integer) The maximum number of virtual cores.
    minMemory number
    (Float) The minimum memory that was allocated to the instance.
    minProcessors number
    (Float) The minimum number of processors that the instance can have.
    minVirtualCores number
    (Integer) The minimum number of virtual cores.
    operatingSystem string
    Operating System
    osType string
    OS Type
    pinPolicy string
    (String) The pinning policy of the instance.
    progress number
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    sharedProcessorPoolId string
    (String) The ID of the shared processor pool for the instance.
    status string
    (String) The status of the instance.
    crn str
    (String) The CRN of this resource.
    dedicated_host_id str
    (String) The dedicated host ID where the shared processor pool resides.
    fault Mapping[str, str]
    (Map) Fault information, if any.
    health_status str
    (String) The health status of the VM.
    ibmi_rds bool
    (Boolean) IBM i Rational Dev Studio.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    (String) The unique identifier of the instance.
    max_memory float
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    max_processors float
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    max_virtual_cores float
    (Integer) The maximum number of virtual cores.
    min_memory float
    (Float) The minimum memory that was allocated to the instance.
    min_processors float
    (Float) The minimum number of processors that the instance can have.
    min_virtual_cores float
    (Integer) The minimum number of virtual cores.
    operating_system str
    Operating System
    os_type str
    OS Type
    pin_policy str
    (String) The pinning policy of the instance.
    progress float
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    shared_processor_pool_id str
    (String) The ID of the shared processor pool for the instance.
    status str
    (String) The status of the instance.
    crn String
    (String) The CRN of this resource.
    dedicatedHostId String
    (String) The dedicated host ID where the shared processor pool resides.
    fault Map<String>
    (Map) Fault information, if any.
    healthStatus String
    (String) The health status of the VM.
    ibmiRds Boolean
    (Boolean) IBM i Rational Dev Studio.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    (String) The unique identifier of the instance.
    maxMemory Number
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    maxProcessors Number
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    maxVirtualCores Number
    (Integer) The maximum number of virtual cores.
    minMemory Number
    (Float) The minimum memory that was allocated to the instance.
    minProcessors Number
    (Float) The minimum number of processors that the instance can have.
    minVirtualCores Number
    (Integer) The minimum number of virtual cores.
    operatingSystem String
    Operating System
    osType String
    OS Type
    pinPolicy String
    (String) The pinning policy of the instance.
    progress Number
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    sharedProcessorPoolId String
    (String) The ID of the shared processor pool for the instance.
    status String
    (String) The status of the instance.

    Look up Existing PiInstance Resource

    Get an existing PiInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PiInstanceState, opts?: CustomResourceOptions): PiInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crn: Optional[str] = None,
        dedicated_host_id: Optional[str] = None,
        fault: Optional[Mapping[str, str]] = None,
        health_status: Optional[str] = None,
        ibmi_rds: Optional[bool] = None,
        instance_id: Optional[str] = None,
        max_memory: Optional[float] = None,
        max_processors: Optional[float] = None,
        max_virtual_cores: Optional[float] = None,
        min_memory: Optional[float] = None,
        min_processors: Optional[float] = None,
        min_virtual_cores: Optional[float] = None,
        operating_system: Optional[str] = None,
        os_type: Optional[str] = None,
        pi_affinity_instance: Optional[str] = None,
        pi_affinity_policy: Optional[str] = None,
        pi_affinity_volume: Optional[str] = None,
        pi_anti_affinity_instances: Optional[Sequence[str]] = None,
        pi_anti_affinity_volumes: Optional[Sequence[str]] = None,
        pi_boot_volume_replication_enabled: Optional[bool] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_deployment_target: Optional[PiInstancePiDeploymentTargetArgs] = None,
        pi_deployment_type: Optional[str] = None,
        pi_health_status: Optional[str] = None,
        pi_ibmi_css: Optional[bool] = None,
        pi_ibmi_pha: Optional[bool] = None,
        pi_ibmi_rds_users: Optional[float] = None,
        pi_image_id: Optional[str] = None,
        pi_instance_id: Optional[str] = None,
        pi_instance_name: Optional[str] = None,
        pi_key_pair_name: Optional[str] = None,
        pi_license_repository_capacity: Optional[float] = None,
        pi_memory: Optional[float] = None,
        pi_networks: Optional[Sequence[PiInstancePiNetworkArgs]] = None,
        pi_pin_policy: Optional[str] = None,
        pi_placement_group_id: Optional[str] = None,
        pi_proc_type: Optional[str] = None,
        pi_processors: Optional[float] = None,
        pi_replicants: Optional[float] = None,
        pi_replication_policy: Optional[str] = None,
        pi_replication_scheme: Optional[str] = None,
        pi_replication_sites: Optional[Sequence[str]] = None,
        pi_retain_virtual_serial_number: Optional[bool] = None,
        pi_sap_deployment_type: Optional[str] = None,
        pi_sap_profile_id: Optional[str] = None,
        pi_shared_processor_pool: Optional[str] = None,
        pi_storage_connection: Optional[str] = None,
        pi_storage_pool: Optional[str] = None,
        pi_storage_pool_affinity: Optional[bool] = None,
        pi_storage_type: Optional[str] = None,
        pi_sys_type: Optional[str] = None,
        pi_user_data: Optional[str] = None,
        pi_user_tags: Optional[Sequence[str]] = None,
        pi_virtual_cores_assigned: Optional[float] = None,
        pi_virtual_optical_device: Optional[str] = None,
        pi_virtual_serial_number: Optional[PiInstancePiVirtualSerialNumberArgs] = None,
        pi_volume_ids: Optional[Sequence[str]] = None,
        pin_policy: Optional[str] = None,
        progress: Optional[float] = None,
        shared_processor_pool_id: Optional[str] = None,
        status: Optional[str] = None,
        timeouts: Optional[PiInstanceTimeoutsArgs] = None) -> PiInstance
    func GetPiInstance(ctx *Context, name string, id IDInput, state *PiInstanceState, opts ...ResourceOption) (*PiInstance, error)
    public static PiInstance Get(string name, Input<string> id, PiInstanceState? state, CustomResourceOptions? opts = null)
    public static PiInstance get(String name, Output<String> id, PiInstanceState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiInstance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Crn string
    (String) The CRN of this resource.
    DedicatedHostId string
    (String) The dedicated host ID where the shared processor pool resides.
    Fault Dictionary<string, string>
    (Map) Fault information, if any.
    HealthStatus string
    (String) The health status of the VM.
    IbmiRds bool
    (Boolean) IBM i Rational Dev Studio.
    InstanceId string
    (String) The unique identifier of the instance.
    MaxMemory double
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    MaxProcessors double
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    MaxVirtualCores double
    (Integer) The maximum number of virtual cores.
    MinMemory double
    (Float) The minimum memory that was allocated to the instance.
    MinProcessors double
    (Float) The minimum number of processors that the instance can have.
    MinVirtualCores double
    (Integer) The minimum number of virtual cores.
    OperatingSystem string
    Operating System
    OsType string
    OS Type
    PiAffinityInstance string
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    PiAffinityVolume string
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances List<string>
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes List<string>
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiBootVolumeReplicationEnabled bool
    Indicates if the boot volume should be replication enabled or not.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiDeploymentTarget PiInstancePiDeploymentTarget

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    PiDeploymentType string
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    PiHealthStatus string
    Allow the user to set the status of the lpar so that they can connect to it faster
    PiIbmiCss bool
    IBM i Cloud Storage Solution.
    PiIbmiPha bool
    IBM i Power High Availability.
    PiIbmiRdsUsers double
    IBM i Rational Dev Studio Number of User Licenses.
    PiImageId string
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    PiInstanceId string
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    PiInstanceName string
    The name of the Power Systems Virtual Server instance.
    PiKeyPairName string
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    PiLicenseRepositoryCapacity double
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    PiMemory double
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    PiNetworks List<PiInstancePiNetwork>
    List of one or more networks to attach to the instance.
    PiPinPolicy string
    Pin Policy of the instance
    PiPlacementGroupId string
    Placement group ID
    PiProcType string
    Instance processor type
    PiProcessors double
    Processors count
    PiReplicants double
    PI Instance replicas count
    PiReplicationPolicy string
    Replication policy for the PI Instance
    PiReplicationScheme string
    Replication scheme
    PiReplicationSites List<string>
    Indicates the replication sites of the boot volume.
    PiRetainVirtualSerialNumber bool
    Indicates whether to retain virtual serial number when changed or deleted.
    PiSapDeploymentType string
    Custom SAP Deployment Type Information
    PiSapProfileId string
    SAP Profile ID for the amount of cores and memory
    PiSharedProcessorPool string
    Shared Processor Pool the instance is deployed on
    PiStorageConnection string
    Storage Connectivity Group for server deployment
    PiStoragePool string
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    PiStoragePoolAffinity bool
    Indicates if all volumes attached to the server must reside in the same storage pool
    PiStorageType string
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    PiSysType string
    PI Instance system type
    PiUserData string
    Base64 encoded data to be passed in for invoking a cloud init script
    PiUserTags List<string>
    The user tags attached to this resource.
    PiVirtualCoresAssigned double
    Virtual Cores Assigned to the PVMInstance
    PiVirtualOpticalDevice string
    Virtual Machine's Cloud Initialization Virtual Optical Device
    PiVirtualSerialNumber PiInstancePiVirtualSerialNumber
    Virtual Serial Number information
    PiVolumeIds List<string>
    List of PI volumes
    PinPolicy string
    (String) The pinning policy of the instance.
    Progress double
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    SharedProcessorPoolId string
    (String) The ID of the shared processor pool for the instance.
    Status string
    (String) The status of the instance.
    Timeouts PiInstanceTimeouts
    Crn string
    (String) The CRN of this resource.
    DedicatedHostId string
    (String) The dedicated host ID where the shared processor pool resides.
    Fault map[string]string
    (Map) Fault information, if any.
    HealthStatus string
    (String) The health status of the VM.
    IbmiRds bool
    (Boolean) IBM i Rational Dev Studio.
    InstanceId string
    (String) The unique identifier of the instance.
    MaxMemory float64
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    MaxProcessors float64
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    MaxVirtualCores float64
    (Integer) The maximum number of virtual cores.
    MinMemory float64
    (Float) The minimum memory that was allocated to the instance.
    MinProcessors float64
    (Float) The minimum number of processors that the instance can have.
    MinVirtualCores float64
    (Integer) The minimum number of virtual cores.
    OperatingSystem string
    Operating System
    OsType string
    OS Type
    PiAffinityInstance string
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    PiAffinityPolicy string
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    PiAffinityVolume string
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    PiAntiAffinityInstances []string
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    PiAntiAffinityVolumes []string
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    PiBootVolumeReplicationEnabled bool
    Indicates if the boot volume should be replication enabled or not.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiDeploymentTarget PiInstancePiDeploymentTargetArgs

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    PiDeploymentType string
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    PiHealthStatus string
    Allow the user to set the status of the lpar so that they can connect to it faster
    PiIbmiCss bool
    IBM i Cloud Storage Solution.
    PiIbmiPha bool
    IBM i Power High Availability.
    PiIbmiRdsUsers float64
    IBM i Rational Dev Studio Number of User Licenses.
    PiImageId string
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    PiInstanceId string
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    PiInstanceName string
    The name of the Power Systems Virtual Server instance.
    PiKeyPairName string
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    PiLicenseRepositoryCapacity float64
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    PiMemory float64
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    PiNetworks []PiInstancePiNetworkArgs
    List of one or more networks to attach to the instance.
    PiPinPolicy string
    Pin Policy of the instance
    PiPlacementGroupId string
    Placement group ID
    PiProcType string
    Instance processor type
    PiProcessors float64
    Processors count
    PiReplicants float64
    PI Instance replicas count
    PiReplicationPolicy string
    Replication policy for the PI Instance
    PiReplicationScheme string
    Replication scheme
    PiReplicationSites []string
    Indicates the replication sites of the boot volume.
    PiRetainVirtualSerialNumber bool
    Indicates whether to retain virtual serial number when changed or deleted.
    PiSapDeploymentType string
    Custom SAP Deployment Type Information
    PiSapProfileId string
    SAP Profile ID for the amount of cores and memory
    PiSharedProcessorPool string
    Shared Processor Pool the instance is deployed on
    PiStorageConnection string
    Storage Connectivity Group for server deployment
    PiStoragePool string
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    PiStoragePoolAffinity bool
    Indicates if all volumes attached to the server must reside in the same storage pool
    PiStorageType string
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    PiSysType string
    PI Instance system type
    PiUserData string
    Base64 encoded data to be passed in for invoking a cloud init script
    PiUserTags []string
    The user tags attached to this resource.
    PiVirtualCoresAssigned float64
    Virtual Cores Assigned to the PVMInstance
    PiVirtualOpticalDevice string
    Virtual Machine's Cloud Initialization Virtual Optical Device
    PiVirtualSerialNumber PiInstancePiVirtualSerialNumberArgs
    Virtual Serial Number information
    PiVolumeIds []string
    List of PI volumes
    PinPolicy string
    (String) The pinning policy of the instance.
    Progress float64
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    SharedProcessorPoolId string
    (String) The ID of the shared processor pool for the instance.
    Status string
    (String) The status of the instance.
    Timeouts PiInstanceTimeoutsArgs
    crn String
    (String) The CRN of this resource.
    dedicatedHostId String
    (String) The dedicated host ID where the shared processor pool resides.
    fault Map<String,String>
    (Map) Fault information, if any.
    healthStatus String
    (String) The health status of the VM.
    ibmiRds Boolean
    (Boolean) IBM i Rational Dev Studio.
    instanceId String
    (String) The unique identifier of the instance.
    maxMemory Double
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    maxProcessors Double
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    maxVirtualCores Double
    (Integer) The maximum number of virtual cores.
    minMemory Double
    (Float) The minimum memory that was allocated to the instance.
    minProcessors Double
    (Float) The minimum number of processors that the instance can have.
    minVirtualCores Double
    (Integer) The minimum number of virtual cores.
    operatingSystem String
    Operating System
    osType String
    OS Type
    piAffinityInstance String
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    piAffinityVolume String
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piBootVolumeReplicationEnabled Boolean
    Indicates if the boot volume should be replication enabled or not.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piDeploymentTarget PiInstancePiDeploymentTarget

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    piDeploymentType String
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    piHealthStatus String
    Allow the user to set the status of the lpar so that they can connect to it faster
    piIbmiCss Boolean
    IBM i Cloud Storage Solution.
    piIbmiPha Boolean
    IBM i Power High Availability.
    piIbmiRdsUsers Double
    IBM i Rational Dev Studio Number of User Licenses.
    piImageId String
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    piInstanceId String
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    piInstanceName String
    The name of the Power Systems Virtual Server instance.
    piKeyPairName String
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    piLicenseRepositoryCapacity Double
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    piMemory Double
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    piNetworks List<PiInstancePiNetwork>
    List of one or more networks to attach to the instance.
    piPinPolicy String
    Pin Policy of the instance
    piPlacementGroupId String
    Placement group ID
    piProcType String
    Instance processor type
    piProcessors Double
    Processors count
    piReplicants Double
    PI Instance replicas count
    piReplicationPolicy String
    Replication policy for the PI Instance
    piReplicationScheme String
    Replication scheme
    piReplicationSites List<String>
    Indicates the replication sites of the boot volume.
    piRetainVirtualSerialNumber Boolean
    Indicates whether to retain virtual serial number when changed or deleted.
    piSapDeploymentType String
    Custom SAP Deployment Type Information
    piSapProfileId String
    SAP Profile ID for the amount of cores and memory
    piSharedProcessorPool String
    Shared Processor Pool the instance is deployed on
    piStorageConnection String
    Storage Connectivity Group for server deployment
    piStoragePool String
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    piStoragePoolAffinity Boolean
    Indicates if all volumes attached to the server must reside in the same storage pool
    piStorageType String
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    piSysType String
    PI Instance system type
    piUserData String
    Base64 encoded data to be passed in for invoking a cloud init script
    piUserTags List<String>
    The user tags attached to this resource.
    piVirtualCoresAssigned Double
    Virtual Cores Assigned to the PVMInstance
    piVirtualOpticalDevice String
    Virtual Machine's Cloud Initialization Virtual Optical Device
    piVirtualSerialNumber PiInstancePiVirtualSerialNumber
    Virtual Serial Number information
    piVolumeIds List<String>
    List of PI volumes
    pinPolicy String
    (String) The pinning policy of the instance.
    progress Double
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    sharedProcessorPoolId String
    (String) The ID of the shared processor pool for the instance.
    status String
    (String) The status of the instance.
    timeouts PiInstanceTimeouts
    crn string
    (String) The CRN of this resource.
    dedicatedHostId string
    (String) The dedicated host ID where the shared processor pool resides.
    fault {[key: string]: string}
    (Map) Fault information, if any.
    healthStatus string
    (String) The health status of the VM.
    ibmiRds boolean
    (Boolean) IBM i Rational Dev Studio.
    instanceId string
    (String) The unique identifier of the instance.
    maxMemory number
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    maxProcessors number
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    maxVirtualCores number
    (Integer) The maximum number of virtual cores.
    minMemory number
    (Float) The minimum memory that was allocated to the instance.
    minProcessors number
    (Float) The minimum number of processors that the instance can have.
    minVirtualCores number
    (Integer) The minimum number of virtual cores.
    operatingSystem string
    Operating System
    osType string
    OS Type
    piAffinityInstance string
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy string
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    piAffinityVolume string
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances string[]
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes string[]
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piBootVolumeReplicationEnabled boolean
    Indicates if the boot volume should be replication enabled or not.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piDeploymentTarget PiInstancePiDeploymentTarget

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    piDeploymentType string
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    piHealthStatus string
    Allow the user to set the status of the lpar so that they can connect to it faster
    piIbmiCss boolean
    IBM i Cloud Storage Solution.
    piIbmiPha boolean
    IBM i Power High Availability.
    piIbmiRdsUsers number
    IBM i Rational Dev Studio Number of User Licenses.
    piImageId string
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    piInstanceId string
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    piInstanceName string
    The name of the Power Systems Virtual Server instance.
    piKeyPairName string
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    piLicenseRepositoryCapacity number
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    piMemory number
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    piNetworks PiInstancePiNetwork[]
    List of one or more networks to attach to the instance.
    piPinPolicy string
    Pin Policy of the instance
    piPlacementGroupId string
    Placement group ID
    piProcType string
    Instance processor type
    piProcessors number
    Processors count
    piReplicants number
    PI Instance replicas count
    piReplicationPolicy string
    Replication policy for the PI Instance
    piReplicationScheme string
    Replication scheme
    piReplicationSites string[]
    Indicates the replication sites of the boot volume.
    piRetainVirtualSerialNumber boolean
    Indicates whether to retain virtual serial number when changed or deleted.
    piSapDeploymentType string
    Custom SAP Deployment Type Information
    piSapProfileId string
    SAP Profile ID for the amount of cores and memory
    piSharedProcessorPool string
    Shared Processor Pool the instance is deployed on
    piStorageConnection string
    Storage Connectivity Group for server deployment
    piStoragePool string
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    piStoragePoolAffinity boolean
    Indicates if all volumes attached to the server must reside in the same storage pool
    piStorageType string
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    piSysType string
    PI Instance system type
    piUserData string
    Base64 encoded data to be passed in for invoking a cloud init script
    piUserTags string[]
    The user tags attached to this resource.
    piVirtualCoresAssigned number
    Virtual Cores Assigned to the PVMInstance
    piVirtualOpticalDevice string
    Virtual Machine's Cloud Initialization Virtual Optical Device
    piVirtualSerialNumber PiInstancePiVirtualSerialNumber
    Virtual Serial Number information
    piVolumeIds string[]
    List of PI volumes
    pinPolicy string
    (String) The pinning policy of the instance.
    progress number
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    sharedProcessorPoolId string
    (String) The ID of the shared processor pool for the instance.
    status string
    (String) The status of the instance.
    timeouts PiInstanceTimeouts
    crn str
    (String) The CRN of this resource.
    dedicated_host_id str
    (String) The dedicated host ID where the shared processor pool resides.
    fault Mapping[str, str]
    (Map) Fault information, if any.
    health_status str
    (String) The health status of the VM.
    ibmi_rds bool
    (Boolean) IBM i Rational Dev Studio.
    instance_id str
    (String) The unique identifier of the instance.
    max_memory float
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    max_processors float
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    max_virtual_cores float
    (Integer) The maximum number of virtual cores.
    min_memory float
    (Float) The minimum memory that was allocated to the instance.
    min_processors float
    (Float) The minimum number of processors that the instance can have.
    min_virtual_cores float
    (Integer) The minimum number of virtual cores.
    operating_system str
    Operating System
    os_type str
    OS Type
    pi_affinity_instance str
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    pi_affinity_policy str
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    pi_affinity_volume str
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    pi_anti_affinity_instances Sequence[str]
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    pi_anti_affinity_volumes Sequence[str]
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    pi_boot_volume_replication_enabled bool
    Indicates if the boot volume should be replication enabled or not.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_deployment_target PiInstancePiDeploymentTargetArgs

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    pi_deployment_type str
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    pi_health_status str
    Allow the user to set the status of the lpar so that they can connect to it faster
    pi_ibmi_css bool
    IBM i Cloud Storage Solution.
    pi_ibmi_pha bool
    IBM i Power High Availability.
    pi_ibmi_rds_users float
    IBM i Rational Dev Studio Number of User Licenses.
    pi_image_id str
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    pi_instance_id str
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    pi_instance_name str
    The name of the Power Systems Virtual Server instance.
    pi_key_pair_name str
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    pi_license_repository_capacity float
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    pi_memory float
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    pi_networks Sequence[PiInstancePiNetworkArgs]
    List of one or more networks to attach to the instance.
    pi_pin_policy str
    Pin Policy of the instance
    pi_placement_group_id str
    Placement group ID
    pi_proc_type str
    Instance processor type
    pi_processors float
    Processors count
    pi_replicants float
    PI Instance replicas count
    pi_replication_policy str
    Replication policy for the PI Instance
    pi_replication_scheme str
    Replication scheme
    pi_replication_sites Sequence[str]
    Indicates the replication sites of the boot volume.
    pi_retain_virtual_serial_number bool
    Indicates whether to retain virtual serial number when changed or deleted.
    pi_sap_deployment_type str
    Custom SAP Deployment Type Information
    pi_sap_profile_id str
    SAP Profile ID for the amount of cores and memory
    pi_shared_processor_pool str
    Shared Processor Pool the instance is deployed on
    pi_storage_connection str
    Storage Connectivity Group for server deployment
    pi_storage_pool str
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    pi_storage_pool_affinity bool
    Indicates if all volumes attached to the server must reside in the same storage pool
    pi_storage_type str
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    pi_sys_type str
    PI Instance system type
    pi_user_data str
    Base64 encoded data to be passed in for invoking a cloud init script
    pi_user_tags Sequence[str]
    The user tags attached to this resource.
    pi_virtual_cores_assigned float
    Virtual Cores Assigned to the PVMInstance
    pi_virtual_optical_device str
    Virtual Machine's Cloud Initialization Virtual Optical Device
    pi_virtual_serial_number PiInstancePiVirtualSerialNumberArgs
    Virtual Serial Number information
    pi_volume_ids Sequence[str]
    List of PI volumes
    pin_policy str
    (String) The pinning policy of the instance.
    progress float
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    shared_processor_pool_id str
    (String) The ID of the shared processor pool for the instance.
    status str
    (String) The status of the instance.
    timeouts PiInstanceTimeoutsArgs
    crn String
    (String) The CRN of this resource.
    dedicatedHostId String
    (String) The dedicated host ID where the shared processor pool resides.
    fault Map<String>
    (Map) Fault information, if any.
    healthStatus String
    (String) The health status of the VM.
    ibmiRds Boolean
    (Boolean) IBM i Rational Dev Studio.
    instanceId String
    (String) The unique identifier of the instance.
    maxMemory Number
    (Float) The maximum amount of memory that can be allocated to the instance without shut down or reboot the LPAR.
    maxProcessors Number
    (Float) The maximum number of processors that can be allocated to the instance with shutting down or rebooting the LPAR.
    maxVirtualCores Number
    (Integer) The maximum number of virtual cores.
    minMemory Number
    (Float) The minimum memory that was allocated to the instance.
    minProcessors Number
    (Float) The minimum number of processors that the instance can have.
    minVirtualCores Number
    (Integer) The minimum number of virtual cores.
    operatingSystem String
    Operating System
    osType String
    OS Type
    piAffinityInstance String
    PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
    piAffinityPolicy String
    Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
    piAffinityVolume String
    Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
    piAntiAffinityInstances List<String>
    List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
    piAntiAffinityVolumes List<String>
    List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
    piBootVolumeReplicationEnabled Boolean
    Indicates if the boot volume should be replication enabled or not.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piDeploymentTarget Property Map

    The deployment of a dedicated host. Max items: 1.

    Nested scheme for pi_deployment_target :

    piDeploymentType String
    Custom deployment type; Allowable value: EPIC or VMNoStorage.
    piHealthStatus String
    Allow the user to set the status of the lpar so that they can connect to it faster
    piIbmiCss Boolean
    IBM i Cloud Storage Solution.
    piIbmiPha Boolean
    IBM i Power High Availability.
    piIbmiRdsUsers Number
    IBM i Rational Dev Studio Number of User Licenses.
    piImageId String
    The ID of the image that you want to use for your Power Systems Virtual Server instance. The image determines the operating system that is installed in your instance. To list available images, run the ibmcloud pi images command.

    • Note:
    • Only images belonging to your project can be used image for deploying a Power Systems Virtual Server instance. To import an images to your project, see ibm_pi_image.
    • If using pi_deployment_type = VMNoStorage then use the following images for the respective OS you intend to create the instance: AIX-EMPTY, IBMI-EMPTY, SLES-EMPTY, RHEL-EMPTY.
    piInstanceId String
    (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<instance_id_1>/.../<instance_id_n>.
    piInstanceName String
    The name of the Power Systems Virtual Server instance.
    piKeyPairName String
    The name of the SSH key that you want to use to access your Power Systems Virtual Server instance. The SSH key must be uploaded to IBM Cloud.
    piLicenseRepositoryCapacity Number
    The VTL license repository capacity TB value. Only use with VTL instances. pi_memory >= 16 + (2 * pi_license_repository_capacity).
    piMemory Number
    The amount of memory that you want to assign to your instance in GB.

    • Required when not creating SAP instances. Conflicts with pi_sap_profile_id.
    piNetworks List<Property Map>
    List of one or more networks to attach to the instance.
    piPinPolicy String
    Pin Policy of the instance
    piPlacementGroupId String
    Placement group ID
    piProcType String
    Instance processor type
    piProcessors Number
    Processors count
    piReplicants Number
    PI Instance replicas count
    piReplicationPolicy String
    Replication policy for the PI Instance
    piReplicationScheme String
    Replication scheme
    piReplicationSites List<String>
    Indicates the replication sites of the boot volume.
    piRetainVirtualSerialNumber Boolean
    Indicates whether to retain virtual serial number when changed or deleted.
    piSapDeploymentType String
    Custom SAP Deployment Type Information
    piSapProfileId String
    SAP Profile ID for the amount of cores and memory
    piSharedProcessorPool String
    Shared Processor Pool the instance is deployed on
    piStorageConnection String
    Storage Connectivity Group for server deployment
    piStoragePool String
    Storage Pool for server deployment; if provided then pi_storage_pool_affinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a VM capture) defaults to the storage pool the image was created in
    piStoragePoolAffinity Boolean
    Indicates if all volumes attached to the server must reside in the same storage pool
    piStorageType String
    Storage type for server deployment; if pi_storage_type is not provided the storage type will default to tier3
    piSysType String
    PI Instance system type
    piUserData String
    Base64 encoded data to be passed in for invoking a cloud init script
    piUserTags List<String>
    The user tags attached to this resource.
    piVirtualCoresAssigned Number
    Virtual Cores Assigned to the PVMInstance
    piVirtualOpticalDevice String
    Virtual Machine's Cloud Initialization Virtual Optical Device
    piVirtualSerialNumber Property Map
    Virtual Serial Number information
    piVolumeIds List<String>
    List of PI volumes
    pinPolicy String
    (String) The pinning policy of the instance.
    progress Number
    (Float) - Specifies the overall progress of the instance deployment process in percentage.
    sharedProcessorPoolId String
    (String) The ID of the shared processor pool for the instance.
    status String
    (String) The status of the instance.
    timeouts Property Map

    Supporting Types

    PiInstancePiDeploymentTarget, PiInstancePiDeploymentTargetArgs

    Id string
    The uuid of the host group or host.
    Type string
    The deployment target type. Supported values are host and hostGroup.
    Id string
    The uuid of the host group or host.
    Type string
    The deployment target type. Supported values are host and hostGroup.
    id String
    The uuid of the host group or host.
    type String
    The deployment target type. Supported values are host and hostGroup.
    id string
    The uuid of the host group or host.
    type string
    The deployment target type. Supported values are host and hostGroup.
    id str
    The uuid of the host group or host.
    type str
    The deployment target type. Supported values are host and hostGroup.
    id String
    The uuid of the host group or host.
    type String
    The deployment target type. Supported values are host and hostGroup.

    PiInstancePiNetwork, PiInstancePiNetworkArgs

    NetworkId string
    The network ID to assign to the instance.
    ExternalIp string
    (String) The external IP address of the network.
    IpAddress string
    The ip address to be used of this network.
    MacAddress string
    (String) The MAC address of the network.
    NetworkInterfaceId string
    (String) ID of the network interface.
    NetworkName string
    (String) The name of the network.
    NetworkSecurityGroupIds List<string>
    The Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used.
    NetworkSecurityGroupsHreves List<string>
    (List) Links to the network security groups that the network interface is a member of.
    Type string
    (String) The type of network.
    NetworkId string
    The network ID to assign to the instance.
    ExternalIp string
    (String) The external IP address of the network.
    IpAddress string
    The ip address to be used of this network.
    MacAddress string
    (String) The MAC address of the network.
    NetworkInterfaceId string
    (String) ID of the network interface.
    NetworkName string
    (String) The name of the network.
    NetworkSecurityGroupIds []string
    The Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used.
    NetworkSecurityGroupsHreves []string
    (List) Links to the network security groups that the network interface is a member of.
    Type string
    (String) The type of network.
    networkId String
    The network ID to assign to the instance.
    externalIp String
    (String) The external IP address of the network.
    ipAddress String
    The ip address to be used of this network.
    macAddress String
    (String) The MAC address of the network.
    networkInterfaceId String
    (String) ID of the network interface.
    networkName String
    (String) The name of the network.
    networkSecurityGroupIds List<String>
    The Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used.
    networkSecurityGroupsHreves List<String>
    (List) Links to the network security groups that the network interface is a member of.
    type String
    (String) The type of network.
    networkId string
    The network ID to assign to the instance.
    externalIp string
    (String) The external IP address of the network.
    ipAddress string
    The ip address to be used of this network.
    macAddress string
    (String) The MAC address of the network.
    networkInterfaceId string
    (String) ID of the network interface.
    networkName string
    (String) The name of the network.
    networkSecurityGroupIds string[]
    The Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used.
    networkSecurityGroupsHreves string[]
    (List) Links to the network security groups that the network interface is a member of.
    type string
    (String) The type of network.
    network_id str
    The network ID to assign to the instance.
    external_ip str
    (String) The external IP address of the network.
    ip_address str
    The ip address to be used of this network.
    mac_address str
    (String) The MAC address of the network.
    network_interface_id str
    (String) ID of the network interface.
    network_name str
    (String) The name of the network.
    network_security_group_ids Sequence[str]
    The Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used.
    network_security_groups_hreves Sequence[str]
    (List) Links to the network security groups that the network interface is a member of.
    type str
    (String) The type of network.
    networkId String
    The network ID to assign to the instance.
    externalIp String
    (String) The external IP address of the network.
    ipAddress String
    The ip address to be used of this network.
    macAddress String
    (String) The MAC address of the network.
    networkInterfaceId String
    (String) ID of the network interface.
    networkName String
    (String) The name of the network.
    networkSecurityGroupIds List<String>
    The Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used.
    networkSecurityGroupsHreves List<String>
    (List) Links to the network security groups that the network interface is a member of.
    type String
    (String) The type of network.

    PiInstancePiVirtualSerialNumber, PiInstancePiVirtualSerialNumberArgs

    Serial string
    Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.
    Description string
    Description of the Virtual Serial Number
    Serial string
    Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.
    Description string
    Description of the Virtual Serial Number
    serial String
    Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.
    description String
    Description of the Virtual Serial Number
    serial string
    Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.
    description string
    Description of the Virtual Serial Number
    serial str
    Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.
    description str
    Description of the Virtual Serial Number
    serial String
    Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.
    description String
    Description of the Virtual Serial Number

    PiInstanceTimeouts, PiInstanceTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    Example

    bash

    $ pulumi import ibm:index/piInstance:PiInstance example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770b112ebb

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm