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

powerflex.NvmeHost

Explore with Pulumi AI

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 NVMe host by its id

$ pulumi import powerflex:index/nvmeHost:NvmeHost nvme_host_import_by_id "<id>"
Copy
  1. This will import the NVMe host 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 NvmeHost Resource

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

Constructor syntax

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

@overload
def NvmeHost(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             nqn: Optional[str] = None,
             max_num_paths: Optional[float] = None,
             max_num_sys_ports: Optional[float] = None,
             name: Optional[str] = None)
func NewNvmeHost(ctx *Context, name string, args NvmeHostArgs, opts ...ResourceOption) (*NvmeHost, error)
public NvmeHost(string name, NvmeHostArgs args, CustomResourceOptions? opts = null)
public NvmeHost(String name, NvmeHostArgs args)
public NvmeHost(String name, NvmeHostArgs args, CustomResourceOptions options)
type: powerflex:NvmeHost
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. NvmeHostArgs
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. NvmeHostArgs
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. NvmeHostArgs
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. NvmeHostArgs
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. NvmeHostArgs
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 nvmeHostResource = new Powerflex.NvmeHost("nvmeHostResource", new()
{
    Nqn = "string",
    MaxNumPaths = 0,
    MaxNumSysPorts = 0,
    Name = "string",
});
Copy
example, err := powerflex.NewNvmeHost(ctx, "nvmeHostResource", &powerflex.NvmeHostArgs{
Nqn: pulumi.String("string"),
MaxNumPaths: pulumi.Float64(0),
MaxNumSysPorts: pulumi.Float64(0),
Name: pulumi.String("string"),
})
Copy
var nvmeHostResource = new NvmeHost("nvmeHostResource", NvmeHostArgs.builder()
    .nqn("string")
    .maxNumPaths(0)
    .maxNumSysPorts(0)
    .name("string")
    .build());
Copy
nvme_host_resource = powerflex.NvmeHost("nvmeHostResource",
    nqn="string",
    max_num_paths=0,
    max_num_sys_ports=0,
    name="string")
Copy
const nvmeHostResource = new powerflex.NvmeHost("nvmeHostResource", {
    nqn: "string",
    maxNumPaths: 0,
    maxNumSysPorts: 0,
    name: "string",
});
Copy
type: powerflex:NvmeHost
properties:
    maxNumPaths: 0
    maxNumSysPorts: 0
    name: string
    nqn: string
Copy

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

Nqn This property is required. string
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
MaxNumPaths double
Number of Paths Per Volume.
MaxNumSysPorts double
Number of System Ports per Protection Domain.
Name string
Name of the NVMe host
Nqn This property is required. string
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
MaxNumPaths float64
Number of Paths Per Volume.
MaxNumSysPorts float64
Number of System Ports per Protection Domain.
Name string
Name of the NVMe host
nqn This property is required. String
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
maxNumPaths Double
Number of Paths Per Volume.
maxNumSysPorts Double
Number of System Ports per Protection Domain.
name String
Name of the NVMe host
nqn This property is required. string
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
maxNumPaths number
Number of Paths Per Volume.
maxNumSysPorts number
Number of System Ports per Protection Domain.
name string
Name of the NVMe host
nqn This property is required. str
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
max_num_paths float
Number of Paths Per Volume.
max_num_sys_ports float
Number of System Ports per Protection Domain.
name str
Name of the NVMe host
nqn This property is required. String
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
maxNumPaths Number
Number of Paths Per Volume.
maxNumSysPorts Number
Number of System Ports per Protection Domain.
name String
Name of the NVMe host

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
SystemId string
The ID of the system.
Id string
The provider-assigned unique ID for this managed resource.
SystemId string
The ID of the system.
id String
The provider-assigned unique ID for this managed resource.
systemId String
The ID of the system.
id string
The provider-assigned unique ID for this managed resource.
systemId string
The ID of the system.
id str
The provider-assigned unique ID for this managed resource.
system_id str
The ID of the system.
id String
The provider-assigned unique ID for this managed resource.
systemId String
The ID of the system.

Look up Existing NvmeHost Resource

Get an existing NvmeHost 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?: NvmeHostState, opts?: CustomResourceOptions): NvmeHost
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        max_num_paths: Optional[float] = None,
        max_num_sys_ports: Optional[float] = None,
        name: Optional[str] = None,
        nqn: Optional[str] = None,
        system_id: Optional[str] = None) -> NvmeHost
func GetNvmeHost(ctx *Context, name string, id IDInput, state *NvmeHostState, opts ...ResourceOption) (*NvmeHost, error)
public static NvmeHost Get(string name, Input<string> id, NvmeHostState? state, CustomResourceOptions? opts = null)
public static NvmeHost get(String name, Output<String> id, NvmeHostState state, CustomResourceOptions options)
resources:  _:    type: powerflex:NvmeHost    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:
MaxNumPaths double
Number of Paths Per Volume.
MaxNumSysPorts double
Number of System Ports per Protection Domain.
Name string
Name of the NVMe host
Nqn string
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
SystemId string
The ID of the system.
MaxNumPaths float64
Number of Paths Per Volume.
MaxNumSysPorts float64
Number of System Ports per Protection Domain.
Name string
Name of the NVMe host
Nqn string
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
SystemId string
The ID of the system.
maxNumPaths Double
Number of Paths Per Volume.
maxNumSysPorts Double
Number of System Ports per Protection Domain.
name String
Name of the NVMe host
nqn String
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
systemId String
The ID of the system.
maxNumPaths number
Number of Paths Per Volume.
maxNumSysPorts number
Number of System Ports per Protection Domain.
name string
Name of the NVMe host
nqn string
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
systemId string
The ID of the system.
max_num_paths float
Number of Paths Per Volume.
max_num_sys_ports float
Number of System Ports per Protection Domain.
name str
Name of the NVMe host
nqn str
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
system_id str
The ID of the system.
maxNumPaths Number
Number of Paths Per Volume.
maxNumSysPorts Number
Number of System Ports per Protection Domain.
name String
Name of the NVMe host
nqn String
NQN of the NVMe host. This attribute must be set during creation and cannot be modified afterwards.
systemId String
The ID of the system.

Package Details

Repository
powerflex dell/terraform-provider-powerflex
License
Notes
This Pulumi package is based on the powerflex Terraform Provider.