ibm.getIsVolume
Explore with Pulumi AI
Retrieve information of an existing IBM Cloud VSI volume. For more information, about the volume concepts, see expandable volume concepts for VPC.
Note:
VPC infrastructure services are a regional specific based endpoint, by default targets to us-south
. Please make sure to target right region in the provider block as shown in the provider.tf
file, if VPC service is created in region other than us-south
.
provider.tf
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) {
}
}
{}
Using getIsVolume
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getIsVolume(args: GetIsVolumeArgs, opts?: InvokeOptions): Promise<GetIsVolumeResult>
function getIsVolumeOutput(args: GetIsVolumeOutputArgs, opts?: InvokeOptions): Output<GetIsVolumeResult>
def get_is_volume(id: Optional[str] = None,
identifier: Optional[str] = None,
name: Optional[str] = None,
zone: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIsVolumeResult
def get_is_volume_output(id: Optional[pulumi.Input[str]] = None,
identifier: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
zone: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIsVolumeResult]
func LookupIsVolume(ctx *Context, args *LookupIsVolumeArgs, opts ...InvokeOption) (*LookupIsVolumeResult, error)
func LookupIsVolumeOutput(ctx *Context, args *LookupIsVolumeOutputArgs, opts ...InvokeOption) LookupIsVolumeResultOutput
> Note: This function is named LookupIsVolume
in the Go SDK.
public static class GetIsVolume
{
public static Task<GetIsVolumeResult> InvokeAsync(GetIsVolumeArgs args, InvokeOptions? opts = null)
public static Output<GetIsVolumeResult> Invoke(GetIsVolumeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetIsVolumeResult> getIsVolume(GetIsVolumeArgs args, InvokeOptions options)
public static Output<GetIsVolumeResult> getIsVolume(GetIsVolumeArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getIsVolume:getIsVolume
arguments:
# arguments dictionary
The following arguments are supported:
- Id string
- Identifier string
- The id of the volume. (one of
identifier
,name
is required) - Name string
- The name of the volume. (one of
identifier
,name
is required) - Zone string
- The zone name of the volume.
- Id string
- Identifier string
- The id of the volume. (one of
identifier
,name
is required) - Name string
- The name of the volume. (one of
identifier
,name
is required) - Zone string
- The zone name of the volume.
- id String
- identifier String
- The id of the volume. (one of
identifier
,name
is required) - name String
- The name of the volume. (one of
identifier
,name
is required) - zone String
- The zone name of the volume.
- id string
- identifier string
- The id of the volume. (one of
identifier
,name
is required) - name string
- The name of the volume. (one of
identifier
,name
is required) - zone string
- The zone name of the volume.
- id str
- identifier str
- The id of the volume. (one of
identifier
,name
is required) - name str
- The name of the volume. (one of
identifier
,name
is required) - zone str
- The zone name of the volume.
- id String
- identifier String
- The id of the volume. (one of
identifier
,name
is required) - name String
- The name of the volume. (one of
identifier
,name
is required) - zone String
- The zone name of the volume.
getIsVolume Result
The following output properties are available:
- List<string>
- (List) Access management tags associated for the volume.
- Active bool
- (Boolean) Indicates whether a running virtual server instance has an attachment to this volume.
- Adjustable
Capacity List<string>States - (List) The attachment states that support adjustable capacity for this volume. Allowable list items are:
attached
,unattached
,unusable
. - Adjustable
Iops List<string>States - (List) The attachment states that support adjustable IOPS for this volume. Allowable list items are:
attached
,unattached
,unusable
. - Attachment
State string - (Boolean) The attachment state of the volume
- Bandwidth double
- The maximum bandwidth (in megabits per second) for the volume
- Busy bool
- (Boolean) Indicates whether this volume is performing an operation that must be serialized. This must be
false
to perform an operation that is specified to require serialization. - Capacity double
- (String) The capacity of the volume in gigabytes.
- Catalog
Offerings List<GetIs Volume Catalog Offering> - (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
- Created
At string - (String) The date and time that the volume was created.
- Crn string
- (String) The crn of this volume.
- Encryption
Key string - (String) The key to use for encrypting this volume.
- Encryption
Type string - (String) The type of ecryption used in the volume [provider_managed, user_managed].
- Health
Reasons List<GetIs Volume Health Reason> - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Id string
- Iops double
- (String) The bandwidth for the volume.
- Operating
Systems List<GetIs Volume Operating System> - (List) The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system. Nested scheme for operating_system:
- Profile string
- (String) The profile to use for this volume.
- Resource
Controller stringUrl - Resource
Crn string - Resource
Group string - (String) The resource group ID for this volume.
- Resource
Group stringName - Resource
Name string - Resource
Status string - Source
Snapshot string - ID of the snapshot, if volume was created from it.
- Status string
- (String) The status of the volume. Supported values are available, failed, pending, unusable, pending_deletion.
- Status
Reasons List<GetIs Volume Status Reason> - (List) Array of reasons for the current status.
- List<string>
- (String) User Tags associated with the volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
- Zone string
- Identifier string
- Name string
- (String) The globally unique name for this operating system.
- []string
- (List) Access management tags associated for the volume.
- Active bool
- (Boolean) Indicates whether a running virtual server instance has an attachment to this volume.
- Adjustable
Capacity []stringStates - (List) The attachment states that support adjustable capacity for this volume. Allowable list items are:
attached
,unattached
,unusable
. - Adjustable
Iops []stringStates - (List) The attachment states that support adjustable IOPS for this volume. Allowable list items are:
attached
,unattached
,unusable
. - Attachment
State string - (Boolean) The attachment state of the volume
- Bandwidth float64
- The maximum bandwidth (in megabits per second) for the volume
- Busy bool
- (Boolean) Indicates whether this volume is performing an operation that must be serialized. This must be
false
to perform an operation that is specified to require serialization. - Capacity float64
- (String) The capacity of the volume in gigabytes.
- Catalog
Offerings []GetIs Volume Catalog Offering - (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
- Created
At string - (String) The date and time that the volume was created.
- Crn string
- (String) The crn of this volume.
- Encryption
Key string - (String) The key to use for encrypting this volume.
- Encryption
Type string - (String) The type of ecryption used in the volume [provider_managed, user_managed].
- Health
Reasons []GetIs Volume Health Reason - (List) The reasons for the current health_state (if any).
- Health
State string - (String) The health of this resource.
- Id string
- Iops float64
- (String) The bandwidth for the volume.
- Operating
Systems []GetIs Volume Operating System - (List) The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system. Nested scheme for operating_system:
- Profile string
- (String) The profile to use for this volume.
- Resource
Controller stringUrl - Resource
Crn string - Resource
Group string - (String) The resource group ID for this volume.
- Resource
Group stringName - Resource
Name string - Resource
Status string - Source
Snapshot string - ID of the snapshot, if volume was created from it.
- Status string
- (String) The status of the volume. Supported values are available, failed, pending, unusable, pending_deletion.
- Status
Reasons []GetIs Volume Status Reason - (List) Array of reasons for the current status.
- []string
- (String) User Tags associated with the volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
- Zone string
- Identifier string
- Name string
- (String) The globally unique name for this operating system.
- List<String>
- (List) Access management tags associated for the volume.
- active Boolean
- (Boolean) Indicates whether a running virtual server instance has an attachment to this volume.
- adjustable
Capacity List<String>States - (List) The attachment states that support adjustable capacity for this volume. Allowable list items are:
attached
,unattached
,unusable
. - adjustable
Iops List<String>States - (List) The attachment states that support adjustable IOPS for this volume. Allowable list items are:
attached
,unattached
,unusable
. - attachment
State String - (Boolean) The attachment state of the volume
- bandwidth Double
- The maximum bandwidth (in megabits per second) for the volume
- busy Boolean
- (Boolean) Indicates whether this volume is performing an operation that must be serialized. This must be
false
to perform an operation that is specified to require serialization. - capacity Double
- (String) The capacity of the volume in gigabytes.
- catalog
Offerings List<GetIs Volume Catalog Offering> - (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
- created
At String - (String) The date and time that the volume was created.
- crn String
- (String) The crn of this volume.
- encryption
Key String - (String) The key to use for encrypting this volume.
- encryption
Type String - (String) The type of ecryption used in the volume [provider_managed, user_managed].
- health
Reasons List<GetIs Volume Health Reason> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- id String
- iops Double
- (String) The bandwidth for the volume.
- operating
Systems List<GetIs Volume Operating System> - (List) The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system. Nested scheme for operating_system:
- profile String
- (String) The profile to use for this volume.
- resource
Controller StringUrl - resource
Crn String - resource
Group String - (String) The resource group ID for this volume.
- resource
Group StringName - resource
Name String - resource
Status String - source
Snapshot String - ID of the snapshot, if volume was created from it.
- status String
- (String) The status of the volume. Supported values are available, failed, pending, unusable, pending_deletion.
- status
Reasons List<GetIs Volume Status Reason> - (List) Array of reasons for the current status.
- List<String>
- (String) User Tags associated with the volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
- zone String
- identifier String
- name String
- (String) The globally unique name for this operating system.
- string[]
- (List) Access management tags associated for the volume.
- active boolean
- (Boolean) Indicates whether a running virtual server instance has an attachment to this volume.
- adjustable
Capacity string[]States - (List) The attachment states that support adjustable capacity for this volume. Allowable list items are:
attached
,unattached
,unusable
. - adjustable
Iops string[]States - (List) The attachment states that support adjustable IOPS for this volume. Allowable list items are:
attached
,unattached
,unusable
. - attachment
State string - (Boolean) The attachment state of the volume
- bandwidth number
- The maximum bandwidth (in megabits per second) for the volume
- busy boolean
- (Boolean) Indicates whether this volume is performing an operation that must be serialized. This must be
false
to perform an operation that is specified to require serialization. - capacity number
- (String) The capacity of the volume in gigabytes.
- catalog
Offerings GetIs Volume Catalog Offering[] - (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
- created
At string - (String) The date and time that the volume was created.
- crn string
- (String) The crn of this volume.
- encryption
Key string - (String) The key to use for encrypting this volume.
- encryption
Type string - (String) The type of ecryption used in the volume [provider_managed, user_managed].
- health
Reasons GetIs Volume Health Reason[] - (List) The reasons for the current health_state (if any).
- health
State string - (String) The health of this resource.
- id string
- iops number
- (String) The bandwidth for the volume.
- operating
Systems GetIs Volume Operating System[] - (List) The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system. Nested scheme for operating_system:
- profile string
- (String) The profile to use for this volume.
- resource
Controller stringUrl - resource
Crn string - resource
Group string - (String) The resource group ID for this volume.
- resource
Group stringName - resource
Name string - resource
Status string - source
Snapshot string - ID of the snapshot, if volume was created from it.
- status string
- (String) The status of the volume. Supported values are available, failed, pending, unusable, pending_deletion.
- status
Reasons GetIs Volume Status Reason[] - (List) Array of reasons for the current status.
- string[]
- (String) User Tags associated with the volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
- zone string
- identifier string
- name string
- (String) The globally unique name for this operating system.
- Sequence[str]
- (List) Access management tags associated for the volume.
- active bool
- (Boolean) Indicates whether a running virtual server instance has an attachment to this volume.
- adjustable_
capacity_ Sequence[str]states - (List) The attachment states that support adjustable capacity for this volume. Allowable list items are:
attached
,unattached
,unusable
. - adjustable_
iops_ Sequence[str]states - (List) The attachment states that support adjustable IOPS for this volume. Allowable list items are:
attached
,unattached
,unusable
. - attachment_
state str - (Boolean) The attachment state of the volume
- bandwidth float
- The maximum bandwidth (in megabits per second) for the volume
- busy bool
- (Boolean) Indicates whether this volume is performing an operation that must be serialized. This must be
false
to perform an operation that is specified to require serialization. - capacity float
- (String) The capacity of the volume in gigabytes.
- catalog_
offerings Sequence[GetIs Volume Catalog Offering] - (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
- created_
at str - (String) The date and time that the volume was created.
- crn str
- (String) The crn of this volume.
- encryption_
key str - (String) The key to use for encrypting this volume.
- encryption_
type str - (String) The type of ecryption used in the volume [provider_managed, user_managed].
- health_
reasons Sequence[GetIs Volume Health Reason] - (List) The reasons for the current health_state (if any).
- health_
state str - (String) The health of this resource.
- id str
- iops float
- (String) The bandwidth for the volume.
- operating_
systems Sequence[GetIs Volume Operating System] - (List) The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system. Nested scheme for operating_system:
- profile str
- (String) The profile to use for this volume.
- resource_
controller_ strurl - resource_
crn str - resource_
group str - (String) The resource group ID for this volume.
- resource_
group_ strname - resource_
name str - resource_
status str - source_
snapshot str - ID of the snapshot, if volume was created from it.
- status str
- (String) The status of the volume. Supported values are available, failed, pending, unusable, pending_deletion.
- status_
reasons Sequence[GetIs Volume Status Reason] - (List) Array of reasons for the current status.
- Sequence[str]
- (String) User Tags associated with the volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
- zone str
- identifier str
- name str
- (String) The globally unique name for this operating system.
- List<String>
- (List) Access management tags associated for the volume.
- active Boolean
- (Boolean) Indicates whether a running virtual server instance has an attachment to this volume.
- adjustable
Capacity List<String>States - (List) The attachment states that support adjustable capacity for this volume. Allowable list items are:
attached
,unattached
,unusable
. - adjustable
Iops List<String>States - (List) The attachment states that support adjustable IOPS for this volume. Allowable list items are:
attached
,unattached
,unusable
. - attachment
State String - (Boolean) The attachment state of the volume
- bandwidth Number
- The maximum bandwidth (in megabits per second) for the volume
- busy Boolean
- (Boolean) Indicates whether this volume is performing an operation that must be serialized. This must be
false
to perform an operation that is specified to require serialization. - capacity Number
- (String) The capacity of the volume in gigabytes.
- catalog
Offerings List<Property Map> - (List) The catalog offering this volume was created from. If a virtual server instance is provisioned with a boot_volume_attachment specifying this volume, the virtual server instance will use this volume's catalog offering, including its pricing plan.If absent, this volume was not created from a catalog offering.
- created
At String - (String) The date and time that the volume was created.
- crn String
- (String) The crn of this volume.
- encryption
Key String - (String) The key to use for encrypting this volume.
- encryption
Type String - (String) The type of ecryption used in the volume [provider_managed, user_managed].
- health
Reasons List<Property Map> - (List) The reasons for the current health_state (if any).
- health
State String - (String) The health of this resource.
- id String
- iops Number
- (String) The bandwidth for the volume.
- operating
Systems List<Property Map> - (List) The operating system associated with this volume. If absent, this volume was not created from an image, or the image did not include an operating system. Nested scheme for operating_system:
- profile String
- (String) The profile to use for this volume.
- resource
Controller StringUrl - resource
Crn String - resource
Group String - (String) The resource group ID for this volume.
- resource
Group StringName - resource
Name String - resource
Status String - source
Snapshot String - ID of the snapshot, if volume was created from it.
- status String
- (String) The status of the volume. Supported values are available, failed, pending, unusable, pending_deletion.
- status
Reasons List<Property Map> - (List) Array of reasons for the current status.
- List<String>
- (String) User Tags associated with the volume. (https://cloud.ibm.com/apidocs/tagging#types-of-tags)
- zone String
- identifier String
- name String
- (String) The globally unique name for this operating system.
Supporting Types
GetIsVolumeCatalogOffering
- Deleteds
List<Get
Is Volume Catalog Offering Deleted> - (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
- Plan
Crn string - (String) The CRN for this catalog offering version's billing plan
- Version
Crn string - (String) The CRN for this version of a catalog offering
- Deleteds
[]Get
Is Volume Catalog Offering Deleted - (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
- Plan
Crn string - (String) The CRN for this catalog offering version's billing plan
- Version
Crn string - (String) The CRN for this version of a catalog offering
- deleteds
List<Get
Is Volume Catalog Offering Deleted> - (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
- plan
Crn String - (String) The CRN for this catalog offering version's billing plan
- version
Crn String - (String) The CRN for this version of a catalog offering
- deleteds
Get
Is Volume Catalog Offering Deleted[] - (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
- plan
Crn string - (String) The CRN for this catalog offering version's billing plan
- version
Crn string - (String) The CRN for this version of a catalog offering
- deleteds
Sequence[Get
Is Volume Catalog Offering Deleted] - (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
- plan_
crn str - (String) The CRN for this catalog offering version's billing plan
- version_
crn str - (String) The CRN for this version of a catalog offering
- deleteds List<Property Map>
- (List) If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
- plan
Crn String - (String) The CRN for this catalog offering version's billing plan
- version
Crn String - (String) The CRN for this version of a catalog offering
GetIsVolumeCatalogOfferingDeleted
- More
Info string - (String) Link to documentation about this status reason
- More
Info string - (String) Link to documentation about this status reason
- more
Info String - (String) Link to documentation about this status reason
- more
Info string - (String) Link to documentation about this status reason
- more_
info str - (String) Link to documentation about this status reason
- more
Info String - (String) Link to documentation about this status reason
GetIsVolumeHealthReason
GetIsVolumeOperatingSystem
- Architecture string
- (String) The operating system architecture
- Dedicated
Host boolOnly - (Boolean) Images with this operating system can only be used on dedicated hosts or dedicated host groups
- Display
Name string - (String) A unique, display-friendly name for the operating system
- Family string
- (String) The software family for this operating system
- Href string
- (String) The URL for this operating system.
- Name string
- The name of the volume. (one of
identifier
,name
is required) - Vendor string
- (String) The vendor of the operating system
- Version string
- (String) The major release version of this operating system
- Architecture string
- (String) The operating system architecture
- Dedicated
Host boolOnly - (Boolean) Images with this operating system can only be used on dedicated hosts or dedicated host groups
- Display
Name string - (String) A unique, display-friendly name for the operating system
- Family string
- (String) The software family for this operating system
- Href string
- (String) The URL for this operating system.
- Name string
- The name of the volume. (one of
identifier
,name
is required) - Vendor string
- (String) The vendor of the operating system
- Version string
- (String) The major release version of this operating system
- architecture String
- (String) The operating system architecture
- dedicated
Host BooleanOnly - (Boolean) Images with this operating system can only be used on dedicated hosts or dedicated host groups
- display
Name String - (String) A unique, display-friendly name for the operating system
- family String
- (String) The software family for this operating system
- href String
- (String) The URL for this operating system.
- name String
- The name of the volume. (one of
identifier
,name
is required) - vendor String
- (String) The vendor of the operating system
- version String
- (String) The major release version of this operating system
- architecture string
- (String) The operating system architecture
- dedicated
Host booleanOnly - (Boolean) Images with this operating system can only be used on dedicated hosts or dedicated host groups
- display
Name string - (String) A unique, display-friendly name for the operating system
- family string
- (String) The software family for this operating system
- href string
- (String) The URL for this operating system.
- name string
- The name of the volume. (one of
identifier
,name
is required) - vendor string
- (String) The vendor of the operating system
- version string
- (String) The major release version of this operating system
- architecture str
- (String) The operating system architecture
- dedicated_
host_ boolonly - (Boolean) Images with this operating system can only be used on dedicated hosts or dedicated host groups
- display_
name str - (String) A unique, display-friendly name for the operating system
- family str
- (String) The software family for this operating system
- href str
- (String) The URL for this operating system.
- name str
- The name of the volume. (one of
identifier
,name
is required) - vendor str
- (String) The vendor of the operating system
- version str
- (String) The major release version of this operating system
- architecture String
- (String) The operating system architecture
- dedicated
Host BooleanOnly - (Boolean) Images with this operating system can only be used on dedicated hosts or dedicated host groups
- display
Name String - (String) A unique, display-friendly name for the operating system
- family String
- (String) The software family for this operating system
- href String
- (String) The URL for this operating system.
- name String
- The name of the volume. (one of
identifier
,name
is required) - vendor String
- (String) The vendor of the operating system
- version String
- (String) The major release version of this operating system
GetIsVolumeStatusReason
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.