1. Packages
  2. Powerflex Provider
  3. API Docs
  4. Device
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell

powerflex.Device

Explore with Pulumi AI

powerflex logo
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell

    Import

    /*

    Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

    Licensed under the Mozilla Public License Version 2.0 (the “License”);

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/
    

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an “AS IS” BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.

    */

    import Protection Device by it’s id

    $ pulumi import powerflex:index/device:Device device_data "<id>"
    
    1. This will import the device instance with specified ID into your Terraform state.

    2. After successful import, you can run terraform state list to ensure the resource has been imported successfully.

    3. Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.

    4. Execute pulumi preview to see if your configuration and the imported resource are in sync. Make adjustments if needed.

    5. Finally, execute pulumi up to bring the resource fully under Terraform’s management.

    6. Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

    Create Device Resource

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

    Constructor syntax

    new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
    @overload
    def Device(resource_name: str,
               args: DeviceArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Device(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               device_path: Optional[str] = None,
               device_capacity: Optional[float] = None,
               external_acceleration_type: Optional[str] = None,
               media_type: Optional[str] = None,
               name: Optional[str] = None,
               protection_domain_id: Optional[str] = None,
               protection_domain_name: Optional[str] = None,
               sds_id: Optional[str] = None,
               sds_name: Optional[str] = None,
               storage_pool_id: Optional[str] = None,
               storage_pool_name: Optional[str] = None)
    func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
    public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
    public Device(String name, DeviceArgs args)
    public Device(String name, DeviceArgs args, CustomResourceOptions options)
    
    type: powerflex:Device
    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 DeviceArgs
    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 DeviceArgs
    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 DeviceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceArgs
    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 deviceResource = new Powerflex.Device("deviceResource", new()
    {
        DevicePath = "string",
        DeviceCapacity = 0,
        ExternalAccelerationType = "string",
        MediaType = "string",
        Name = "string",
        ProtectionDomainId = "string",
        ProtectionDomainName = "string",
        SdsId = "string",
        SdsName = "string",
        StoragePoolId = "string",
        StoragePoolName = "string",
    });
    
    example, err := powerflex.NewDevice(ctx, "deviceResource", &powerflex.DeviceArgs{
    	DevicePath:               pulumi.String("string"),
    	DeviceCapacity:           pulumi.Float64(0),
    	ExternalAccelerationType: pulumi.String("string"),
    	MediaType:                pulumi.String("string"),
    	Name:                     pulumi.String("string"),
    	ProtectionDomainId:       pulumi.String("string"),
    	ProtectionDomainName:     pulumi.String("string"),
    	SdsId:                    pulumi.String("string"),
    	SdsName:                  pulumi.String("string"),
    	StoragePoolId:            pulumi.String("string"),
    	StoragePoolName:          pulumi.String("string"),
    })
    
    var deviceResource = new Device("deviceResource", DeviceArgs.builder()
        .devicePath("string")
        .deviceCapacity(0)
        .externalAccelerationType("string")
        .mediaType("string")
        .name("string")
        .protectionDomainId("string")
        .protectionDomainName("string")
        .sdsId("string")
        .sdsName("string")
        .storagePoolId("string")
        .storagePoolName("string")
        .build());
    
    device_resource = powerflex.Device("deviceResource",
        device_path="string",
        device_capacity=0,
        external_acceleration_type="string",
        media_type="string",
        name="string",
        protection_domain_id="string",
        protection_domain_name="string",
        sds_id="string",
        sds_name="string",
        storage_pool_id="string",
        storage_pool_name="string")
    
    const deviceResource = new powerflex.Device("deviceResource", {
        devicePath: "string",
        deviceCapacity: 0,
        externalAccelerationType: "string",
        mediaType: "string",
        name: "string",
        protectionDomainId: "string",
        protectionDomainName: "string",
        sdsId: "string",
        sdsName: "string",
        storagePoolId: "string",
        storagePoolName: "string",
    });
    
    type: powerflex:Device
    properties:
        deviceCapacity: 0
        devicePath: string
        externalAccelerationType: string
        mediaType: string
        name: string
        protectionDomainId: string
        protectionDomainName: string
        sdsId: string
        sdsName: string
        storagePoolId: string
        storagePoolName: string
    

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

    DevicePath string
    The current path of the device. Cannot be updated.
    DeviceCapacity double
    Capacity of the device in GB.
    ExternalAccelerationType string
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    MediaType string
    Media type of the device. Valid values are HDD, SSD.
    Name string
    The name of the device.
    ProtectionDomainId string
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    ProtectionDomainName string
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    SdsId string
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    SdsName string
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    StoragePoolId string
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    StoragePoolName string
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    DevicePath string
    The current path of the device. Cannot be updated.
    DeviceCapacity float64
    Capacity of the device in GB.
    ExternalAccelerationType string
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    MediaType string
    Media type of the device. Valid values are HDD, SSD.
    Name string
    The name of the device.
    ProtectionDomainId string
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    ProtectionDomainName string
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    SdsId string
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    SdsName string
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    StoragePoolId string
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    StoragePoolName string
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    devicePath String
    The current path of the device. Cannot be updated.
    deviceCapacity Double
    Capacity of the device in GB.
    externalAccelerationType String
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    mediaType String
    Media type of the device. Valid values are HDD, SSD.
    name String
    The name of the device.
    protectionDomainId String
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protectionDomainName String
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sdsId String
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sdsName String
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storagePoolId String
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storagePoolName String
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    devicePath string
    The current path of the device. Cannot be updated.
    deviceCapacity number
    Capacity of the device in GB.
    externalAccelerationType string
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    mediaType string
    Media type of the device. Valid values are HDD, SSD.
    name string
    The name of the device.
    protectionDomainId string
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protectionDomainName string
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sdsId string
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sdsName string
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storagePoolId string
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storagePoolName string
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    device_path str
    The current path of the device. Cannot be updated.
    device_capacity float
    Capacity of the device in GB.
    external_acceleration_type str
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    media_type str
    Media type of the device. Valid values are HDD, SSD.
    name str
    The name of the device.
    protection_domain_id str
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protection_domain_name str
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sds_id str
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sds_name str
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storage_pool_id str
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storage_pool_name str
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    devicePath String
    The current path of the device. Cannot be updated.
    deviceCapacity Number
    Capacity of the device in GB.
    externalAccelerationType String
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    mediaType String
    Media type of the device. Valid values are HDD, SSD.
    name String
    The name of the device.
    protectionDomainId String
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protectionDomainName String
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sdsId String
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sdsName String
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storagePoolId String
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storagePoolName String
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.

    Outputs

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

    DeviceCapacityInKb double
    Capacity of the device in KB.
    DeviceOriginalPath string
    Original path of the device.
    DeviceState string
    State of the device.
    Id string
    The provider-assigned unique ID for this managed resource.
    DeviceCapacityInKb float64
    Capacity of the device in KB.
    DeviceOriginalPath string
    Original path of the device.
    DeviceState string
    State of the device.
    Id string
    The provider-assigned unique ID for this managed resource.
    deviceCapacityInKb Double
    Capacity of the device in KB.
    deviceOriginalPath String
    Original path of the device.
    deviceState String
    State of the device.
    id String
    The provider-assigned unique ID for this managed resource.
    deviceCapacityInKb number
    Capacity of the device in KB.
    deviceOriginalPath string
    Original path of the device.
    deviceState string
    State of the device.
    id string
    The provider-assigned unique ID for this managed resource.
    device_capacity_in_kb float
    Capacity of the device in KB.
    device_original_path str
    Original path of the device.
    device_state str
    State of the device.
    id str
    The provider-assigned unique ID for this managed resource.
    deviceCapacityInKb Number
    Capacity of the device in KB.
    deviceOriginalPath String
    Original path of the device.
    deviceState String
    State of the device.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Device Resource

    Get an existing Device 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?: DeviceState, opts?: CustomResourceOptions): Device
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device_capacity: Optional[float] = None,
            device_capacity_in_kb: Optional[float] = None,
            device_original_path: Optional[str] = None,
            device_path: Optional[str] = None,
            device_state: Optional[str] = None,
            external_acceleration_type: Optional[str] = None,
            media_type: Optional[str] = None,
            name: Optional[str] = None,
            protection_domain_id: Optional[str] = None,
            protection_domain_name: Optional[str] = None,
            sds_id: Optional[str] = None,
            sds_name: Optional[str] = None,
            storage_pool_id: Optional[str] = None,
            storage_pool_name: Optional[str] = None) -> Device
    func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
    public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
    public static Device get(String name, Output<String> id, DeviceState state, CustomResourceOptions options)
    resources:  _:    type: powerflex:Device    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:
    DeviceCapacity double
    Capacity of the device in GB.
    DeviceCapacityInKb double
    Capacity of the device in KB.
    DeviceOriginalPath string
    Original path of the device.
    DevicePath string
    The current path of the device. Cannot be updated.
    DeviceState string
    State of the device.
    ExternalAccelerationType string
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    MediaType string
    Media type of the device. Valid values are HDD, SSD.
    Name string
    The name of the device.
    ProtectionDomainId string
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    ProtectionDomainName string
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    SdsId string
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    SdsName string
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    StoragePoolId string
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    StoragePoolName string
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    DeviceCapacity float64
    Capacity of the device in GB.
    DeviceCapacityInKb float64
    Capacity of the device in KB.
    DeviceOriginalPath string
    Original path of the device.
    DevicePath string
    The current path of the device. Cannot be updated.
    DeviceState string
    State of the device.
    ExternalAccelerationType string
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    MediaType string
    Media type of the device. Valid values are HDD, SSD.
    Name string
    The name of the device.
    ProtectionDomainId string
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    ProtectionDomainName string
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    SdsId string
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    SdsName string
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    StoragePoolId string
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    StoragePoolName string
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    deviceCapacity Double
    Capacity of the device in GB.
    deviceCapacityInKb Double
    Capacity of the device in KB.
    deviceOriginalPath String
    Original path of the device.
    devicePath String
    The current path of the device. Cannot be updated.
    deviceState String
    State of the device.
    externalAccelerationType String
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    mediaType String
    Media type of the device. Valid values are HDD, SSD.
    name String
    The name of the device.
    protectionDomainId String
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protectionDomainName String
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sdsId String
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sdsName String
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storagePoolId String
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storagePoolName String
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    deviceCapacity number
    Capacity of the device in GB.
    deviceCapacityInKb number
    Capacity of the device in KB.
    deviceOriginalPath string
    Original path of the device.
    devicePath string
    The current path of the device. Cannot be updated.
    deviceState string
    State of the device.
    externalAccelerationType string
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    mediaType string
    Media type of the device. Valid values are HDD, SSD.
    name string
    The name of the device.
    protectionDomainId string
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protectionDomainName string
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sdsId string
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sdsName string
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storagePoolId string
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storagePoolName string
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    device_capacity float
    Capacity of the device in GB.
    device_capacity_in_kb float
    Capacity of the device in KB.
    device_original_path str
    Original path of the device.
    device_path str
    The current path of the device. Cannot be updated.
    device_state str
    State of the device.
    external_acceleration_type str
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    media_type str
    Media type of the device. Valid values are HDD, SSD.
    name str
    The name of the device.
    protection_domain_id str
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protection_domain_name str
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sds_id str
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sds_name str
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storage_pool_id str
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storage_pool_name str
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.
    deviceCapacity Number
    Capacity of the device in GB.
    deviceCapacityInKb Number
    Capacity of the device in KB.
    deviceOriginalPath String
    Original path of the device.
    devicePath String
    The current path of the device. Cannot be updated.
    deviceState String
    State of the device.
    externalAccelerationType String
    External acceleration type of the device. Valid values are None, Read, Write, ReadAndWrite.
    mediaType String
    Media type of the device. Valid values are HDD, SSD.
    name String
    The name of the device.
    protectionDomainId String
    ID of the protection domain. Conflicts with protection_domain_name. Cannot be updated.
    protectionDomainName String
    Name of the protection domain. Conflicts with protection_domain_id. Cannot be updated.
    sdsId String
    ID of the SDS. Conflicts with sds_name. Cannot be updated.
    sdsName String
    Name of the SDS. Conflicts with sds_id. Cannot be updated.
    storagePoolId String
    ID of the storage pool. Conflicts with storage_pool_name. Cannot be updated.
    storagePoolName String
    Name of the storage pool. Conflicts with storage_pool_id. Cannot be updated.

    Package Details

    Repository
    powerflex dell/terraform-provider-powerflex
    License
    Notes
    This Pulumi package is based on the powerflex Terraform Provider.
    powerflex logo
    powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell