Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. PiVirtualSerialNumber
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.PiVirtualSerialNumber

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, get, update or delete an existing virtual serial number.

Example Usage

The following example enables you to create a virtual serial number:

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

const testaccVirtualSerialNumber = new ibm.PiVirtualSerialNumber("testaccVirtualSerialNumber", {
    piCloudInstanceId: "<value of the cloud_instance_id>",
    piDescription: "<desired description for virtual serial number>",
    piSerial: "<existing virtual serial number>",
});
Copy
import pulumi
import pulumi_ibm as ibm

testacc_virtual_serial_number = ibm.PiVirtualSerialNumber("testaccVirtualSerialNumber",
    pi_cloud_instance_id="<value of the cloud_instance_id>",
    pi_description="<desired description for virtual serial number>",
    pi_serial="<existing virtual serial number>")
Copy
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.NewPiVirtualSerialNumber(ctx, "testaccVirtualSerialNumber", &ibm.PiVirtualSerialNumberArgs{
			PiCloudInstanceId: pulumi.String("<value of the cloud_instance_id>"),
			PiDescription:     pulumi.String("<desired description for virtual serial number>"),
			PiSerial:          pulumi.String("<existing virtual serial number>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var testaccVirtualSerialNumber = new Ibm.PiVirtualSerialNumber("testaccVirtualSerialNumber", new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
        PiDescription = "<desired description for virtual serial number>",
        PiSerial = "<existing virtual serial number>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiVirtualSerialNumber;
import com.pulumi.ibm.PiVirtualSerialNumberArgs;
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 testaccVirtualSerialNumber = new PiVirtualSerialNumber("testaccVirtualSerialNumber", PiVirtualSerialNumberArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piDescription("<desired description for virtual serial number>")
            .piSerial("<existing virtual serial number>")
            .build());

    }
}
Copy
resources:
  testaccVirtualSerialNumber:
    type: ibm:PiVirtualSerialNumber
    properties:
      piCloudInstanceId: <value of the cloud_instance_id>
      piDescription: <desired description for virtual serial number>
      piSerial: <existing virtual serial number>
Copy

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";
Copy
import pulumi
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Note This resource is used to create a virtual serial number by assigning to a power instance using ‘auto-assign’. Otherwise, it can only be used to manage an existing virtual serial number. If deleting an instance with a ibm.PiVirtualSerialNumber resource assigned, it is recommended to unassign the virtual serial number resource from the instance before destruction.

Create PiVirtualSerialNumber Resource

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

Constructor syntax

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

@overload
def PiVirtualSerialNumber(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          pi_cloud_instance_id: Optional[str] = None,
                          pi_serial: Optional[str] = None,
                          pi_description: Optional[str] = None,
                          pi_instance_id: Optional[str] = None,
                          pi_retain_virtual_serial_number: Optional[bool] = None,
                          pi_virtual_serial_number_id: Optional[str] = None,
                          timeouts: Optional[PiVirtualSerialNumberTimeoutsArgs] = None)
func NewPiVirtualSerialNumber(ctx *Context, name string, args PiVirtualSerialNumberArgs, opts ...ResourceOption) (*PiVirtualSerialNumber, error)
public PiVirtualSerialNumber(string name, PiVirtualSerialNumberArgs args, CustomResourceOptions? opts = null)
public PiVirtualSerialNumber(String name, PiVirtualSerialNumberArgs args)
public PiVirtualSerialNumber(String name, PiVirtualSerialNumberArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PiVirtualSerialNumberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PiVirtualSerialNumberArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PiVirtualSerialNumberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PiVirtualSerialNumberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PiVirtualSerialNumberArgs
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 piVirtualSerialNumberResource = new Ibm.PiVirtualSerialNumber("piVirtualSerialNumberResource", new()
{
    PiCloudInstanceId = "string",
    PiSerial = "string",
    PiDescription = "string",
    PiInstanceId = "string",
    PiRetainVirtualSerialNumber = false,
    PiVirtualSerialNumberId = "string",
    Timeouts = new Ibm.Inputs.PiVirtualSerialNumberTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewPiVirtualSerialNumber(ctx, "piVirtualSerialNumberResource", &ibm.PiVirtualSerialNumberArgs{
PiCloudInstanceId: pulumi.String("string"),
PiSerial: pulumi.String("string"),
PiDescription: pulumi.String("string"),
PiInstanceId: pulumi.String("string"),
PiRetainVirtualSerialNumber: pulumi.Bool(false),
PiVirtualSerialNumberId: pulumi.String("string"),
Timeouts: &.PiVirtualSerialNumberTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var piVirtualSerialNumberResource = new PiVirtualSerialNumber("piVirtualSerialNumberResource", PiVirtualSerialNumberArgs.builder()
    .piCloudInstanceId("string")
    .piSerial("string")
    .piDescription("string")
    .piInstanceId("string")
    .piRetainVirtualSerialNumber(false)
    .piVirtualSerialNumberId("string")
    .timeouts(PiVirtualSerialNumberTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
pi_virtual_serial_number_resource = ibm.PiVirtualSerialNumber("piVirtualSerialNumberResource",
    pi_cloud_instance_id="string",
    pi_serial="string",
    pi_description="string",
    pi_instance_id="string",
    pi_retain_virtual_serial_number=False,
    pi_virtual_serial_number_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const piVirtualSerialNumberResource = new ibm.PiVirtualSerialNumber("piVirtualSerialNumberResource", {
    piCloudInstanceId: "string",
    piSerial: "string",
    piDescription: "string",
    piInstanceId: "string",
    piRetainVirtualSerialNumber: false,
    piVirtualSerialNumberId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:PiVirtualSerialNumber
properties:
    piCloudInstanceId: string
    piDescription: string
    piInstanceId: string
    piRetainVirtualSerialNumber: false
    piSerial: string
    piVirtualSerialNumberId: string
    timeouts:
        create: string
        delete: string
        update: string
Copy

PiVirtualSerialNumber 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 PiVirtualSerialNumber resource accepts the following input properties:

PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
PiSerial This property is required. string
Virtual serial number.
PiDescription string
Desired description for virtual serial number.
PiInstanceId string
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
PiRetainVirtualSerialNumber bool
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
PiVirtualSerialNumberId string
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
Timeouts PiVirtualSerialNumberTimeouts
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
PiSerial This property is required. string
Virtual serial number.
PiDescription string
Desired description for virtual serial number.
PiInstanceId string
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
PiRetainVirtualSerialNumber bool
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
PiVirtualSerialNumberId string
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
Timeouts PiVirtualSerialNumberTimeoutsArgs
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
piSerial This property is required. String
Virtual serial number.
piDescription String
Desired description for virtual serial number.
piInstanceId String
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
piRetainVirtualSerialNumber Boolean
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
piVirtualSerialNumberId String
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts PiVirtualSerialNumberTimeouts
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
piSerial This property is required. string
Virtual serial number.
piDescription string
Desired description for virtual serial number.
piInstanceId string
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
piRetainVirtualSerialNumber boolean
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
piVirtualSerialNumberId string
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts PiVirtualSerialNumberTimeouts
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
pi_serial This property is required. str
Virtual serial number.
pi_description str
Desired description for virtual serial number.
pi_instance_id str
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
pi_retain_virtual_serial_number bool
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
pi_virtual_serial_number_id str
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts PiVirtualSerialNumberTimeoutsArgs
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
piSerial This property is required. String
Virtual serial number.
piDescription String
Desired description for virtual serial number.
piInstanceId String
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
piRetainVirtualSerialNumber Boolean
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
piVirtualSerialNumberId String
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts Property Map

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing PiVirtualSerialNumber Resource

Get an existing PiVirtualSerialNumber 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?: PiVirtualSerialNumberState, opts?: CustomResourceOptions): PiVirtualSerialNumber
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_description: Optional[str] = None,
        pi_instance_id: Optional[str] = None,
        pi_retain_virtual_serial_number: Optional[bool] = None,
        pi_serial: Optional[str] = None,
        pi_virtual_serial_number_id: Optional[str] = None,
        timeouts: Optional[PiVirtualSerialNumberTimeoutsArgs] = None) -> PiVirtualSerialNumber
func GetPiVirtualSerialNumber(ctx *Context, name string, id IDInput, state *PiVirtualSerialNumberState, opts ...ResourceOption) (*PiVirtualSerialNumber, error)
public static PiVirtualSerialNumber Get(string name, Input<string> id, PiVirtualSerialNumberState? state, CustomResourceOptions? opts = null)
public static PiVirtualSerialNumber get(String name, Output<String> id, PiVirtualSerialNumberState state, CustomResourceOptions options)
resources:  _:    type: ibm:PiVirtualSerialNumber    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
PiCloudInstanceId string
The GUID of the service instance associated with an account.
PiDescription string
Desired description for virtual serial number.
PiInstanceId string
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
PiRetainVirtualSerialNumber bool
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
PiSerial string
Virtual serial number.
PiVirtualSerialNumberId string
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
Timeouts PiVirtualSerialNumberTimeouts
PiCloudInstanceId string
The GUID of the service instance associated with an account.
PiDescription string
Desired description for virtual serial number.
PiInstanceId string
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
PiRetainVirtualSerialNumber bool
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
PiSerial string
Virtual serial number.
PiVirtualSerialNumberId string
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
Timeouts PiVirtualSerialNumberTimeoutsArgs
piCloudInstanceId String
The GUID of the service instance associated with an account.
piDescription String
Desired description for virtual serial number.
piInstanceId String
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
piRetainVirtualSerialNumber Boolean
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
piSerial String
Virtual serial number.
piVirtualSerialNumberId String
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts PiVirtualSerialNumberTimeouts
piCloudInstanceId string
The GUID of the service instance associated with an account.
piDescription string
Desired description for virtual serial number.
piInstanceId string
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
piRetainVirtualSerialNumber boolean
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
piSerial string
Virtual serial number.
piVirtualSerialNumberId string
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts PiVirtualSerialNumberTimeouts
pi_cloud_instance_id str
The GUID of the service instance associated with an account.
pi_description str
Desired description for virtual serial number.
pi_instance_id str
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
pi_retain_virtual_serial_number bool
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
pi_serial str
Virtual serial number.
pi_virtual_serial_number_id str
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts PiVirtualSerialNumberTimeoutsArgs
piCloudInstanceId String
The GUID of the service instance associated with an account.
piDescription String
Desired description for virtual serial number.
piInstanceId String
Power instance ID to assign created or existing virtual serial number to. Must unassign from previous power instance if different than current assignment. Cannot use the instance name, only ID. Please see note on pi_virtual_serial_number in the ibm.PiInstance resource documentation.
piRetainVirtualSerialNumber Boolean
Indicates whether to reserve or delete virtual serial number when detached from power instance during deletion. Required with pi_instance_id. Default behavior does not retain virtual serial number after deletion.
piSerial String
Virtual serial number.
piVirtualSerialNumberId String
(String) The unique identifier of the virtual serial number. Composed of <cloud_instance_id>/<virtual_serial_number>
timeouts Property Map

Supporting Types

PiVirtualSerialNumberTimeouts
, PiVirtualSerialNumberTimeoutsArgs

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/piVirtualSerialNumber:PiVirtualSerialNumber example d7bec597-4726-451f-8a63-e62e6f19c32c/VS0762Y
Copy

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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm