powerflex.NvmeTarget
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 target by its id
$ pulumi import powerflex:index/nvmeTarget:NvmeTarget nvme_target_import_by_id "<id>"
This will import the NVMe target instance with specified ID into your Terraform state.
After successful import, you can run terraform state list to ensure the resource has been imported successfully.
Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.
Execute pulumi preview to see if your configuration and the imported resource are in sync. Make adjustments if needed.
Finally, execute pulumi up to bring the resource fully under Terraform’s management.
Now, the resource which was not part of terraform became part of Terraform managed infrastructure.
Create NvmeTarget Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NvmeTarget(name: string, args: NvmeTargetArgs, opts?: CustomResourceOptions);
@overload
def NvmeTarget(resource_name: str,
args: NvmeTargetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NvmeTarget(resource_name: str,
opts: Optional[ResourceOptions] = None,
ip_lists: Optional[Sequence[NvmeTargetIpListArgs]] = None,
discovery_port: Optional[float] = None,
maintenance_state: Optional[str] = None,
name: Optional[str] = None,
nvme_port: Optional[float] = None,
protection_domain_id: Optional[str] = None,
protection_domain_name: Optional[str] = None,
storage_port: Optional[float] = None)
func NewNvmeTarget(ctx *Context, name string, args NvmeTargetArgs, opts ...ResourceOption) (*NvmeTarget, error)
public NvmeTarget(string name, NvmeTargetArgs args, CustomResourceOptions? opts = null)
public NvmeTarget(String name, NvmeTargetArgs args)
public NvmeTarget(String name, NvmeTargetArgs args, CustomResourceOptions options)
type: powerflex:NvmeTarget
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 NvmeTargetArgs
- 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 NvmeTargetArgs
- 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 NvmeTargetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NvmeTargetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NvmeTargetArgs
- 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 nvmeTargetResource = new Powerflex.NvmeTarget("nvmeTargetResource", new()
{
IpLists = new[]
{
new Powerflex.Inputs.NvmeTargetIpListArgs
{
Ip = "string",
Role = "string",
},
},
DiscoveryPort = 0,
MaintenanceState = "string",
Name = "string",
NvmePort = 0,
ProtectionDomainId = "string",
ProtectionDomainName = "string",
StoragePort = 0,
});
example, err := powerflex.NewNvmeTarget(ctx, "nvmeTargetResource", &powerflex.NvmeTargetArgs{
IpLists: powerflex.NvmeTargetIpListArray{
&powerflex.NvmeTargetIpListArgs{
Ip: pulumi.String("string"),
Role: pulumi.String("string"),
},
},
DiscoveryPort: pulumi.Float64(0),
MaintenanceState: pulumi.String("string"),
Name: pulumi.String("string"),
NvmePort: pulumi.Float64(0),
ProtectionDomainId: pulumi.String("string"),
ProtectionDomainName: pulumi.String("string"),
StoragePort: pulumi.Float64(0),
})
var nvmeTargetResource = new NvmeTarget("nvmeTargetResource", NvmeTargetArgs.builder()
.ipLists(NvmeTargetIpListArgs.builder()
.ip("string")
.role("string")
.build())
.discoveryPort(0)
.maintenanceState("string")
.name("string")
.nvmePort(0)
.protectionDomainId("string")
.protectionDomainName("string")
.storagePort(0)
.build());
nvme_target_resource = powerflex.NvmeTarget("nvmeTargetResource",
ip_lists=[{
"ip": "string",
"role": "string",
}],
discovery_port=0,
maintenance_state="string",
name="string",
nvme_port=0,
protection_domain_id="string",
protection_domain_name="string",
storage_port=0)
const nvmeTargetResource = new powerflex.NvmeTarget("nvmeTargetResource", {
ipLists: [{
ip: "string",
role: "string",
}],
discoveryPort: 0,
maintenanceState: "string",
name: "string",
nvmePort: 0,
protectionDomainId: "string",
protectionDomainName: "string",
storagePort: 0,
});
type: powerflex:NvmeTarget
properties:
discoveryPort: 0
ipLists:
- ip: string
role: string
maintenanceState: string
name: string
nvmePort: 0
protectionDomainId: string
protectionDomainName: string
storagePort: 0
NvmeTarget 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 NvmeTarget resource accepts the following input properties:
- Ip
Lists List<NvmeTarget Ip List> - List of IPs associated with the NVMe target.
- Discovery
Port double - The discovery port of the NVMe target (default: 8009).
- Maintenance
State string - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- Name string
- Name of the NVMe target
- Nvme
Port double - The NVMe port of the NVMe target (default: 4420).
- Protection
Domain stringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Protection
Domain stringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Storage
Port double - The storage port of the NVMe target (default: 12200).
- Ip
Lists []NvmeTarget Ip List Args - List of IPs associated with the NVMe target.
- Discovery
Port float64 - The discovery port of the NVMe target (default: 8009).
- Maintenance
State string - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- Name string
- Name of the NVMe target
- Nvme
Port float64 - The NVMe port of the NVMe target (default: 4420).
- Protection
Domain stringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Protection
Domain stringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Storage
Port float64 - The storage port of the NVMe target (default: 12200).
- ip
Lists List<NvmeTarget Ip List> - List of IPs associated with the NVMe target.
- discovery
Port Double - The discovery port of the NVMe target (default: 8009).
- maintenance
State String - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- name String
- Name of the NVMe target
- nvme
Port Double - The NVMe port of the NVMe target (default: 4420).
- protection
Domain StringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection
Domain StringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - storage
Port Double - The storage port of the NVMe target (default: 12200).
- ip
Lists NvmeTarget Ip List[] - List of IPs associated with the NVMe target.
- discovery
Port number - The discovery port of the NVMe target (default: 8009).
- maintenance
State string - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- name string
- Name of the NVMe target
- nvme
Port number - The NVMe port of the NVMe target (default: 4420).
- protection
Domain stringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection
Domain stringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - storage
Port number - The storage port of the NVMe target (default: 12200).
- ip_
lists Sequence[NvmeTarget Ip List Args] - List of IPs associated with the NVMe target.
- discovery_
port float - The discovery port of the NVMe target (default: 8009).
- maintenance_
state str - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- name str
- Name of the NVMe target
- nvme_
port float - The NVMe port of the NVMe target (default: 4420).
- protection_
domain_ strid - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection_
domain_ strname - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - storage_
port float - The storage port of the NVMe target (default: 12200).
- ip
Lists List<Property Map> - List of IPs associated with the NVMe target.
- discovery
Port Number - The discovery port of the NVMe target (default: 8009).
- maintenance
State String - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- name String
- Name of the NVMe target
- nvme
Port Number - The NVMe port of the NVMe target (default: 4420).
- protection
Domain StringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection
Domain StringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - storage
Port Number - The storage port of the NVMe target (default: 12200).
Outputs
All input properties are implicitly available as output properties. Additionally, the NvmeTarget resource produces the following output properties:
- Authentication
Error string - The authentication error of the NVMe target.
- Fault
Set stringId - The fault set ID of the NVMe target.
- Id string
- The provider-assigned unique ID for this managed resource.
- Mdm
Connection stringState - The MDM connection state of the NVMe target.
- Membership
State string - The membership state of the NVMe target.
- Sdt
State string - The state of the NVMe target.
- Software
Version stringInfo - The software version information of the NVMe target.
- System
Id string - The ID of the system.
- Authentication
Error string - The authentication error of the NVMe target.
- Fault
Set stringId - The fault set ID of the NVMe target.
- Id string
- The provider-assigned unique ID for this managed resource.
- Mdm
Connection stringState - The MDM connection state of the NVMe target.
- Membership
State string - The membership state of the NVMe target.
- Sdt
State string - The state of the NVMe target.
- Software
Version stringInfo - The software version information of the NVMe target.
- System
Id string - The ID of the system.
- authentication
Error String - The authentication error of the NVMe target.
- fault
Set StringId - The fault set ID of the NVMe target.
- id String
- The provider-assigned unique ID for this managed resource.
- mdm
Connection StringState - The MDM connection state of the NVMe target.
- membership
State String - The membership state of the NVMe target.
- sdt
State String - The state of the NVMe target.
- software
Version StringInfo - The software version information of the NVMe target.
- system
Id String - The ID of the system.
- authentication
Error string - The authentication error of the NVMe target.
- fault
Set stringId - The fault set ID of the NVMe target.
- id string
- The provider-assigned unique ID for this managed resource.
- mdm
Connection stringState - The MDM connection state of the NVMe target.
- membership
State string - The membership state of the NVMe target.
- sdt
State string - The state of the NVMe target.
- software
Version stringInfo - The software version information of the NVMe target.
- system
Id string - The ID of the system.
- authentication_
error str - The authentication error of the NVMe target.
- fault_
set_ strid - The fault set ID of the NVMe target.
- id str
- The provider-assigned unique ID for this managed resource.
- mdm_
connection_ strstate - The MDM connection state of the NVMe target.
- membership_
state str - The membership state of the NVMe target.
- sdt_
state str - The state of the NVMe target.
- software_
version_ strinfo - The software version information of the NVMe target.
- system_
id str - The ID of the system.
- authentication
Error String - The authentication error of the NVMe target.
- fault
Set StringId - The fault set ID of the NVMe target.
- id String
- The provider-assigned unique ID for this managed resource.
- mdm
Connection StringState - The MDM connection state of the NVMe target.
- membership
State String - The membership state of the NVMe target.
- sdt
State String - The state of the NVMe target.
- software
Version StringInfo - The software version information of the NVMe target.
- system
Id String - The ID of the system.
Look up Existing NvmeTarget Resource
Get an existing NvmeTarget 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?: NvmeTargetState, opts?: CustomResourceOptions): NvmeTarget
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authentication_error: Optional[str] = None,
discovery_port: Optional[float] = None,
fault_set_id: Optional[str] = None,
ip_lists: Optional[Sequence[NvmeTargetIpListArgs]] = None,
maintenance_state: Optional[str] = None,
mdm_connection_state: Optional[str] = None,
membership_state: Optional[str] = None,
name: Optional[str] = None,
nvme_port: Optional[float] = None,
protection_domain_id: Optional[str] = None,
protection_domain_name: Optional[str] = None,
sdt_state: Optional[str] = None,
software_version_info: Optional[str] = None,
storage_port: Optional[float] = None,
system_id: Optional[str] = None) -> NvmeTarget
func GetNvmeTarget(ctx *Context, name string, id IDInput, state *NvmeTargetState, opts ...ResourceOption) (*NvmeTarget, error)
public static NvmeTarget Get(string name, Input<string> id, NvmeTargetState? state, CustomResourceOptions? opts = null)
public static NvmeTarget get(String name, Output<String> id, NvmeTargetState state, CustomResourceOptions options)
resources: _: type: powerflex:NvmeTarget 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.
- Authentication
Error string - The authentication error of the NVMe target.
- Discovery
Port double - The discovery port of the NVMe target (default: 8009).
- Fault
Set stringId - The fault set ID of the NVMe target.
- Ip
Lists List<NvmeTarget Ip List> - List of IPs associated with the NVMe target.
- Maintenance
State string - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- Mdm
Connection stringState - The MDM connection state of the NVMe target.
- Membership
State string - The membership state of the NVMe target.
- Name string
- Name of the NVMe target
- Nvme
Port double - The NVMe port of the NVMe target (default: 4420).
- Protection
Domain stringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Protection
Domain stringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Sdt
State string - The state of the NVMe target.
- Software
Version stringInfo - The software version information of the NVMe target.
- Storage
Port double - The storage port of the NVMe target (default: 12200).
- System
Id string - The ID of the system.
- Authentication
Error string - The authentication error of the NVMe target.
- Discovery
Port float64 - The discovery port of the NVMe target (default: 8009).
- Fault
Set stringId - The fault set ID of the NVMe target.
- Ip
Lists []NvmeTarget Ip List Args - List of IPs associated with the NVMe target.
- Maintenance
State string - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- Mdm
Connection stringState - The MDM connection state of the NVMe target.
- Membership
State string - The membership state of the NVMe target.
- Name string
- Name of the NVMe target
- Nvme
Port float64 - The NVMe port of the NVMe target (default: 4420).
- Protection
Domain stringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Protection
Domain stringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - Sdt
State string - The state of the NVMe target.
- Software
Version stringInfo - The software version information of the NVMe target.
- Storage
Port float64 - The storage port of the NVMe target (default: 12200).
- System
Id string - The ID of the system.
- authentication
Error String - The authentication error of the NVMe target.
- discovery
Port Double - The discovery port of the NVMe target (default: 8009).
- fault
Set StringId - The fault set ID of the NVMe target.
- ip
Lists List<NvmeTarget Ip List> - List of IPs associated with the NVMe target.
- maintenance
State String - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- mdm
Connection StringState - The MDM connection state of the NVMe target.
- membership
State String - The membership state of the NVMe target.
- name String
- Name of the NVMe target
- nvme
Port Double - The NVMe port of the NVMe target (default: 4420).
- protection
Domain StringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection
Domain StringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - sdt
State String - The state of the NVMe target.
- software
Version StringInfo - The software version information of the NVMe target.
- storage
Port Double - The storage port of the NVMe target (default: 12200).
- system
Id String - The ID of the system.
- authentication
Error string - The authentication error of the NVMe target.
- discovery
Port number - The discovery port of the NVMe target (default: 8009).
- fault
Set stringId - The fault set ID of the NVMe target.
- ip
Lists NvmeTarget Ip List[] - List of IPs associated with the NVMe target.
- maintenance
State string - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- mdm
Connection stringState - The MDM connection state of the NVMe target.
- membership
State string - The membership state of the NVMe target.
- name string
- Name of the NVMe target
- nvme
Port number - The NVMe port of the NVMe target (default: 4420).
- protection
Domain stringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection
Domain stringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - sdt
State string - The state of the NVMe target.
- software
Version stringInfo - The software version information of the NVMe target.
- storage
Port number - The storage port of the NVMe target (default: 12200).
- system
Id string - The ID of the system.
- authentication_
error str - The authentication error of the NVMe target.
- discovery_
port float - The discovery port of the NVMe target (default: 8009).
- fault_
set_ strid - The fault set ID of the NVMe target.
- ip_
lists Sequence[NvmeTarget Ip List Args] - List of IPs associated with the NVMe target.
- maintenance_
state str - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- mdm_
connection_ strstate - The MDM connection state of the NVMe target.
- membership_
state str - The membership state of the NVMe target.
- name str
- Name of the NVMe target
- nvme_
port float - The NVMe port of the NVMe target (default: 4420).
- protection_
domain_ strid - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection_
domain_ strname - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - sdt_
state str - The state of the NVMe target.
- software_
version_ strinfo - The software version information of the NVMe target.
- storage_
port float - The storage port of the NVMe target (default: 12200).
- system_
id str - The ID of the system.
- authentication
Error String - The authentication error of the NVMe target.
- discovery
Port Number - The discovery port of the NVMe target (default: 8009).
- fault
Set StringId - The fault set ID of the NVMe target.
- ip
Lists List<Property Map> - List of IPs associated with the NVMe target.
- maintenance
State String - The maintenance state of the NVMe target. Active to trigger enter maintenance mode; Inactive to exit maintenance mode.
- mdm
Connection StringState - The MDM connection state of the NVMe target.
- membership
State String - The membership state of the NVMe target.
- name String
- Name of the NVMe target
- nvme
Port Number - The NVMe port of the NVMe target (default: 4420).
- protection
Domain StringId - ID of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainname'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - protection
Domain StringName - Name of the Protection Domain under which the NVMe target will be created. Conflicts with 'protectiondomainid'. Cannot be updated.Note: Either
protection_domain_id
orprotection_domain_name
must be specified. - sdt
State String - The state of the NVMe target.
- software
Version StringInfo - The software version information of the NVMe target.
- storage
Port Number - The storage port of the NVMe target (default: 12200).
- system
Id String - The ID of the system.
Supporting Types
NvmeTargetIpList, NvmeTargetIpListArgs
Package Details
- Repository
- powerflex dell/terraform-provider-powerflex
- License
- Notes
- This Pulumi package is based on the
powerflex
Terraform Provider.