Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. User
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.User

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

    This resource is used to manage the User entity of PowerScale Array. We can Create, Update and Delete the User using this resource. We can also import an existing User from PowerScale array. PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.

    Example Usage

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

// PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
const testUser = new powerscale.User("testUser", {});

    import pulumi
import pulumi_powerscale as powerscale

# PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
test_user = powerscale.User("testUser")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
		_, err := powerscale.NewUser(ctx, "testUser", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;

return await Deployment.RunAsync(() => 
{
    // PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
    var testUser = new Powerscale.User("testUser");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.User;
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) {
        // PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
        var testUser = new User("testUser");

    }
}

    resources:
  # PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.
  testUser:
    type: powerscale:User

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         domain: Optional[str] = None,
         email: Optional[str] = None,
         enabled: Optional[bool] = None,
         expiry: Optional[float] = None,
         gecos: Optional[str] = None,
         home_directory: Optional[str] = None,
         name: Optional[str] = None,
         password: Optional[str] = None,
         password_expires: Optional[bool] = None,
         primary_group: Optional[str] = None,
         prompt_password_change: Optional[bool] = None,
         query_force: Optional[bool] = None,
         query_provider: Optional[str] = None,
         query_zone: Optional[str] = None,
         roles: Optional[Sequence[str]] = None,
         shell: Optional[str] = None,
         sid: Optional[str] = None,
         uid: Optional[float] = None,
         unlock: Optional[bool] = None)
    func NewUser(ctx *Context, name string, args *UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs? args = null, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: powerscale:User
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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 userResource = new Powerscale.User("userResource", new()
{
    Domain = "string",
    Email = "string",
    Enabled = false,
    Expiry = 0,
    Gecos = "string",
    HomeDirectory = "string",
    Name = "string",
    Password = "string",
    PasswordExpires = false,
    PrimaryGroup = "string",
    PromptPasswordChange = false,
    QueryForce = false,
    QueryProvider = "string",
    QueryZone = "string",
    Roles = new[]
    {
        "string",
    },
    Shell = "string",
    Sid = "string",
    Uid = 0,
    Unlock = false,
});

    example, err := powerscale.NewUser(ctx, "userResource", &powerscale.UserArgs{
	Domain:               pulumi.String("string"),
	Email:                pulumi.String("string"),
	Enabled:              pulumi.Bool(false),
	Expiry:               pulumi.Float64(0),
	Gecos:                pulumi.String("string"),
	HomeDirectory:        pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Password:             pulumi.String("string"),
	PasswordExpires:      pulumi.Bool(false),
	PrimaryGroup:         pulumi.String("string"),
	PromptPasswordChange: pulumi.Bool(false),
	QueryForce:           pulumi.Bool(false),
	QueryProvider:        pulumi.String("string"),
	QueryZone:            pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Shell:  pulumi.String("string"),
	Sid:    pulumi.String("string"),
	Uid:    pulumi.Float64(0),
	Unlock: pulumi.Bool(false),
})

    var userResource = new User("userResource", UserArgs.builder()
    .domain("string")
    .email("string")
    .enabled(false)
    .expiry(0)
    .gecos("string")
    .homeDirectory("string")
    .name("string")
    .password("string")
    .passwordExpires(false)
    .primaryGroup("string")
    .promptPasswordChange(false)
    .queryForce(false)
    .queryProvider("string")
    .queryZone("string")
    .roles("string")
    .shell("string")
    .sid("string")
    .uid(0)
    .unlock(false)
    .build());

    user_resource = powerscale.User("userResource",
    domain="string",
    email="string",
    enabled=False,
    expiry=0,
    gecos="string",
    home_directory="string",
    name="string",
    password="string",
    password_expires=False,
    primary_group="string",
    prompt_password_change=False,
    query_force=False,
    query_provider="string",
    query_zone="string",
    roles=["string"],
    shell="string",
    sid="string",
    uid=0,
    unlock=False)

    const userResource = new powerscale.User("userResource", {
    domain: "string",
    email: "string",
    enabled: false,
    expiry: 0,
    gecos: "string",
    homeDirectory: "string",
    name: "string",
    password: "string",
    passwordExpires: false,
    primaryGroup: "string",
    promptPasswordChange: false,
    queryForce: false,
    queryProvider: "string",
    queryZone: "string",
    roles: ["string"],
    shell: "string",
    sid: "string",
    uid: 0,
    unlock: false,
});

    type: powerscale:User
properties:
    domain: string
    email: string
    enabled: false
    expiry: 0
    gecos: string
    homeDirectory: string
    name: string
    password: string
    passwordExpires: false
    primaryGroup: string
    promptPasswordChange: false
    queryForce: false
    queryProvider: string
    queryZone: string
    roles:
        - string
    shell: string
    sid: string
    uid: 0
    unlock: false

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

    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    Email string
    Specifies an email address.
    Enabled bool
    If true, the authenticated user is enabled.
    Expiry double
    Specifies the Unix Epoch time at which the authenticated user will expire.
    Gecos string
    Specifies the GECOS value, which is usually the full name.
    HomeDirectory string
    Specifies a home directory for the user.
    Name string
    Specifies a user name. Cannot be updated.
    Password string
    Sets or Changes the password for the user.
    PasswordExpires bool
    If true, the password is allowed to expire.
    PrimaryGroup string
    Specifies the name of the primary group.
    PromptPasswordChange bool
    If true, Prompts the user to change their password at the next login.
    QueryForce bool
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles List<string>
    List of roles, the user is assigned.
    Shell string
    Specifies a path to the shell for the user.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Uid double
    Specifies a numeric user identifier.
    Unlock bool
    If true, the user account should be unlocked.
    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    Email string
    Specifies an email address.
    Enabled bool
    If true, the authenticated user is enabled.
    Expiry float64
    Specifies the Unix Epoch time at which the authenticated user will expire.
    Gecos string
    Specifies the GECOS value, which is usually the full name.
    HomeDirectory string
    Specifies a home directory for the user.
    Name string
    Specifies a user name. Cannot be updated.
    Password string
    Sets or Changes the password for the user.
    PasswordExpires bool
    If true, the password is allowed to expire.
    PrimaryGroup string
    Specifies the name of the primary group.
    PromptPasswordChange bool
    If true, Prompts the user to change their password at the next login.
    QueryForce bool
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles []string
    List of roles, the user is assigned.
    Shell string
    Specifies a path to the shell for the user.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Uid float64
    Specifies a numeric user identifier.
    Unlock bool
    If true, the user account should be unlocked.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    email String
    Specifies an email address.
    enabled Boolean
    If true, the authenticated user is enabled.
    expiry Double
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos String
    Specifies the GECOS value, which is usually the full name.
    homeDirectory String
    Specifies a home directory for the user.
    name String
    Specifies a user name. Cannot be updated.
    password String
    Sets or Changes the password for the user.
    passwordExpires Boolean
    If true, the password is allowed to expire.
    primaryGroup String
    Specifies the name of the primary group.
    promptPasswordChange Boolean
    If true, Prompts the user to change their password at the next login.
    queryForce Boolean
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    shell String
    Specifies a path to the shell for the user.
    sid String
    Specifies a security identifier. Cannot be updated.
    uid Double
    Specifies a numeric user identifier.
    unlock Boolean
    If true, the user account should be unlocked.
    domain string
    Specifies the domain that the object is part of. Cannot be updated.
    email string
    Specifies an email address.
    enabled boolean
    If true, the authenticated user is enabled.
    expiry number
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos string
    Specifies the GECOS value, which is usually the full name.
    homeDirectory string
    Specifies a home directory for the user.
    name string
    Specifies a user name. Cannot be updated.
    password string
    Sets or Changes the password for the user.
    passwordExpires boolean
    If true, the password is allowed to expire.
    primaryGroup string
    Specifies the name of the primary group.
    promptPasswordChange boolean
    If true, Prompts the user to change their password at the next login.
    queryForce boolean
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    queryProvider string
    Specifies the provider type. Cannot be updated.
    queryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    roles string[]
    List of roles, the user is assigned.
    shell string
    Specifies a path to the shell for the user.
    sid string
    Specifies a security identifier. Cannot be updated.
    uid number
    Specifies a numeric user identifier.
    unlock boolean
    If true, the user account should be unlocked.
    domain str
    Specifies the domain that the object is part of. Cannot be updated.
    email str
    Specifies an email address.
    enabled bool
    If true, the authenticated user is enabled.
    expiry float
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos str
    Specifies the GECOS value, which is usually the full name.
    home_directory str
    Specifies a home directory for the user.
    name str
    Specifies a user name. Cannot be updated.
    password str
    Sets or Changes the password for the user.
    password_expires bool
    If true, the password is allowed to expire.
    primary_group str
    Specifies the name of the primary group.
    prompt_password_change bool
    If true, Prompts the user to change their password at the next login.
    query_force bool
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    query_provider str
    Specifies the provider type. Cannot be updated.
    query_zone str
    Specifies the zone that the object belongs to. Cannot be updated.
    roles Sequence[str]
    List of roles, the user is assigned.
    shell str
    Specifies a path to the shell for the user.
    sid str
    Specifies a security identifier. Cannot be updated.
    uid float
    Specifies a numeric user identifier.
    unlock bool
    If true, the user account should be unlocked.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    email String
    Specifies an email address.
    enabled Boolean
    If true, the authenticated user is enabled.
    expiry Number
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos String
    Specifies the GECOS value, which is usually the full name.
    homeDirectory String
    Specifies a home directory for the user.
    name String
    Specifies a user name. Cannot be updated.
    password String
    Sets or Changes the password for the user.
    passwordExpires Boolean
    If true, the password is allowed to expire.
    primaryGroup String
    Specifies the name of the primary group.
    promptPasswordChange Boolean
    If true, Prompts the user to change their password at the next login.
    queryForce Boolean
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    shell String
    Specifies a path to the shell for the user.
    sid String
    Specifies a security identifier. Cannot be updated.
    uid Number
    Specifies a numeric user identifier.
    unlock Boolean
    If true, the user account should be unlocked.

    Outputs

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

    Dn string
    Specifies a principal name for the user.
    DnsDomain string
    Specifies the DNS domain.
    Expired bool
    If true, the authenticated user has expired.
    GeneratedGid bool
    If true, the GID was generated.
    GeneratedUid bool
    If true, the UID was generated.
    GeneratedUpn bool
    If true, the UPN was generated.
    Gid UserGid
    Specifies a group identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    Locked bool
    If true, indicates that the account is locked.
    MaxPasswordAge double
    Specifies the maximum time in seconds allowed before the password expires.
    PasswordExpired bool
    If true, the password has expired.
    PasswordExpiry double
    Specifies the time in Unix Epoch seconds that the password will expire.
    PasswordLastSet double
    Specifies the last time the password was set.
    PrimaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    SamAccountName string
    Specifies a user name.
    Type string
    Specifies the object type.
    Upn string
    Specifies a principal name for the user.
    UserCanChangePassword bool
    Specifies whether the password for the user can be changed.
    Dn string
    Specifies a principal name for the user.
    DnsDomain string
    Specifies the DNS domain.
    Expired bool
    If true, the authenticated user has expired.
    GeneratedGid bool
    If true, the GID was generated.
    GeneratedUid bool
    If true, the UID was generated.
    GeneratedUpn bool
    If true, the UPN was generated.
    Gid UserGid
    Specifies a group identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    Locked bool
    If true, indicates that the account is locked.
    MaxPasswordAge float64
    Specifies the maximum time in seconds allowed before the password expires.
    PasswordExpired bool
    If true, the password has expired.
    PasswordExpiry float64
    Specifies the time in Unix Epoch seconds that the password will expire.
    PasswordLastSet float64
    Specifies the last time the password was set.
    PrimaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    SamAccountName string
    Specifies a user name.
    Type string
    Specifies the object type.
    Upn string
    Specifies a principal name for the user.
    UserCanChangePassword bool
    Specifies whether the password for the user can be changed.
    dn String
    Specifies a principal name for the user.
    dnsDomain String
    Specifies the DNS domain.
    expired Boolean
    If true, the authenticated user has expired.
    generatedGid Boolean
    If true, the GID was generated.
    generatedUid Boolean
    If true, the UID was generated.
    generatedUpn Boolean
    If true, the UPN was generated.
    gid UserGid
    Specifies a group identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    locked Boolean
    If true, indicates that the account is locked.
    maxPasswordAge Double
    Specifies the maximum time in seconds allowed before the password expires.
    passwordExpired Boolean
    If true, the password has expired.
    passwordExpiry Double
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet Double
    Specifies the last time the password was set.
    primaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    providerName String
    Specifies the authentication provider that the object belongs to.
    samAccountName String
    Specifies a user name.
    type String
    Specifies the object type.
    upn String
    Specifies a principal name for the user.
    userCanChangePassword Boolean
    Specifies whether the password for the user can be changed.
    dn string
    Specifies a principal name for the user.
    dnsDomain string
    Specifies the DNS domain.
    expired boolean
    If true, the authenticated user has expired.
    generatedGid boolean
    If true, the GID was generated.
    generatedUid boolean
    If true, the UID was generated.
    generatedUpn boolean
    If true, the UPN was generated.
    gid UserGid
    Specifies a group identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    locked boolean
    If true, indicates that the account is locked.
    maxPasswordAge number
    Specifies the maximum time in seconds allowed before the password expires.
    passwordExpired boolean
    If true, the password has expired.
    passwordExpiry number
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet number
    Specifies the last time the password was set.
    primaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    providerName string
    Specifies the authentication provider that the object belongs to.
    samAccountName string
    Specifies a user name.
    type string
    Specifies the object type.
    upn string
    Specifies a principal name for the user.
    userCanChangePassword boolean
    Specifies whether the password for the user can be changed.
    dn str
    Specifies a principal name for the user.
    dns_domain str
    Specifies the DNS domain.
    expired bool
    If true, the authenticated user has expired.
    generated_gid bool
    If true, the GID was generated.
    generated_uid bool
    If true, the UID was generated.
    generated_upn bool
    If true, the UPN was generated.
    gid UserGid
    Specifies a group identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    locked bool
    If true, indicates that the account is locked.
    max_password_age float
    Specifies the maximum time in seconds allowed before the password expires.
    password_expired bool
    If true, the password has expired.
    password_expiry float
    Specifies the time in Unix Epoch seconds that the password will expire.
    password_last_set float
    Specifies the last time the password was set.
    primary_group_sid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    provider_name str
    Specifies the authentication provider that the object belongs to.
    sam_account_name str
    Specifies a user name.
    type str
    Specifies the object type.
    upn str
    Specifies a principal name for the user.
    user_can_change_password bool
    Specifies whether the password for the user can be changed.
    dn String
    Specifies a principal name for the user.
    dnsDomain String
    Specifies the DNS domain.
    expired Boolean
    If true, the authenticated user has expired.
    generatedGid Boolean
    If true, the GID was generated.
    generatedUid Boolean
    If true, the UID was generated.
    generatedUpn Boolean
    If true, the UPN was generated.
    gid Property Map
    Specifies a group identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    locked Boolean
    If true, indicates that the account is locked.
    maxPasswordAge Number
    Specifies the maximum time in seconds allowed before the password expires.
    passwordExpired Boolean
    If true, the password has expired.
    passwordExpiry Number
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet Number
    Specifies the last time the password was set.
    primaryGroupSid Property Map
    Specifies the persona of the primary group.
    providerName String
    Specifies the authentication provider that the object belongs to.
    samAccountName String
    Specifies a user name.
    type String
    Specifies the object type.
    upn String
    Specifies a principal name for the user.
    userCanChangePassword Boolean
    Specifies whether the password for the user can be changed.

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dn: Optional[str] = None,
        dns_domain: Optional[str] = None,
        domain: Optional[str] = None,
        email: Optional[str] = None,
        enabled: Optional[bool] = None,
        expired: Optional[bool] = None,
        expiry: Optional[float] = None,
        gecos: Optional[str] = None,
        generated_gid: Optional[bool] = None,
        generated_uid: Optional[bool] = None,
        generated_upn: Optional[bool] = None,
        gid: Optional[UserGidArgs] = None,
        home_directory: Optional[str] = None,
        locked: Optional[bool] = None,
        max_password_age: Optional[float] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        password_expired: Optional[bool] = None,
        password_expires: Optional[bool] = None,
        password_expiry: Optional[float] = None,
        password_last_set: Optional[float] = None,
        primary_group: Optional[str] = None,
        primary_group_sid: Optional[UserPrimaryGroupSidArgs] = None,
        prompt_password_change: Optional[bool] = None,
        provider_name: Optional[str] = None,
        query_force: Optional[bool] = None,
        query_provider: Optional[str] = None,
        query_zone: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        sam_account_name: Optional[str] = None,
        shell: Optional[str] = None,
        sid: Optional[str] = None,
        type: Optional[str] = None,
        uid: Optional[float] = None,
        unlock: Optional[bool] = None,
        upn: Optional[str] = None,
        user_can_change_password: Optional[bool] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:User    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:
    Dn string
    Specifies a principal name for the user.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    Email string
    Specifies an email address.
    Enabled bool
    If true, the authenticated user is enabled.
    Expired bool
    If true, the authenticated user has expired.
    Expiry double
    Specifies the Unix Epoch time at which the authenticated user will expire.
    Gecos string
    Specifies the GECOS value, which is usually the full name.
    GeneratedGid bool
    If true, the GID was generated.
    GeneratedUid bool
    If true, the UID was generated.
    GeneratedUpn bool
    If true, the UPN was generated.
    Gid UserGid
    Specifies a group identifier.
    HomeDirectory string
    Specifies a home directory for the user.
    Locked bool
    If true, indicates that the account is locked.
    MaxPasswordAge double
    Specifies the maximum time in seconds allowed before the password expires.
    Name string
    Specifies a user name. Cannot be updated.
    Password string
    Sets or Changes the password for the user.
    PasswordExpired bool
    If true, the password has expired.
    PasswordExpires bool
    If true, the password is allowed to expire.
    PasswordExpiry double
    Specifies the time in Unix Epoch seconds that the password will expire.
    PasswordLastSet double
    Specifies the last time the password was set.
    PrimaryGroup string
    Specifies the name of the primary group.
    PrimaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    PromptPasswordChange bool
    If true, Prompts the user to change their password at the next login.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    QueryForce bool
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles List<string>
    List of roles, the user is assigned.
    SamAccountName string
    Specifies a user name.
    Shell string
    Specifies a path to the shell for the user.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Type string
    Specifies the object type.
    Uid double
    Specifies a numeric user identifier.
    Unlock bool
    If true, the user account should be unlocked.
    Upn string
    Specifies a principal name for the user.
    UserCanChangePassword bool
    Specifies whether the password for the user can be changed.
    Dn string
    Specifies a principal name for the user.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    Email string
    Specifies an email address.
    Enabled bool
    If true, the authenticated user is enabled.
    Expired bool
    If true, the authenticated user has expired.
    Expiry float64
    Specifies the Unix Epoch time at which the authenticated user will expire.
    Gecos string
    Specifies the GECOS value, which is usually the full name.
    GeneratedGid bool
    If true, the GID was generated.
    GeneratedUid bool
    If true, the UID was generated.
    GeneratedUpn bool
    If true, the UPN was generated.
    Gid UserGidArgs
    Specifies a group identifier.
    HomeDirectory string
    Specifies a home directory for the user.
    Locked bool
    If true, indicates that the account is locked.
    MaxPasswordAge float64
    Specifies the maximum time in seconds allowed before the password expires.
    Name string
    Specifies a user name. Cannot be updated.
    Password string
    Sets or Changes the password for the user.
    PasswordExpired bool
    If true, the password has expired.
    PasswordExpires bool
    If true, the password is allowed to expire.
    PasswordExpiry float64
    Specifies the time in Unix Epoch seconds that the password will expire.
    PasswordLastSet float64
    Specifies the last time the password was set.
    PrimaryGroup string
    Specifies the name of the primary group.
    PrimaryGroupSid UserPrimaryGroupSidArgs
    Specifies the persona of the primary group.
    PromptPasswordChange bool
    If true, Prompts the user to change their password at the next login.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    QueryForce bool
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles []string
    List of roles, the user is assigned.
    SamAccountName string
    Specifies a user name.
    Shell string
    Specifies a path to the shell for the user.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Type string
    Specifies the object type.
    Uid float64
    Specifies a numeric user identifier.
    Unlock bool
    If true, the user account should be unlocked.
    Upn string
    Specifies a principal name for the user.
    UserCanChangePassword bool
    Specifies whether the password for the user can be changed.
    dn String
    Specifies a principal name for the user.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    email String
    Specifies an email address.
    enabled Boolean
    If true, the authenticated user is enabled.
    expired Boolean
    If true, the authenticated user has expired.
    expiry Double
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos String
    Specifies the GECOS value, which is usually the full name.
    generatedGid Boolean
    If true, the GID was generated.
    generatedUid Boolean
    If true, the UID was generated.
    generatedUpn Boolean
    If true, the UPN was generated.
    gid UserGid
    Specifies a group identifier.
    homeDirectory String
    Specifies a home directory for the user.
    locked Boolean
    If true, indicates that the account is locked.
    maxPasswordAge Double
    Specifies the maximum time in seconds allowed before the password expires.
    name String
    Specifies a user name. Cannot be updated.
    password String
    Sets or Changes the password for the user.
    passwordExpired Boolean
    If true, the password has expired.
    passwordExpires Boolean
    If true, the password is allowed to expire.
    passwordExpiry Double
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet Double
    Specifies the last time the password was set.
    primaryGroup String
    Specifies the name of the primary group.
    primaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    promptPasswordChange Boolean
    If true, Prompts the user to change their password at the next login.
    providerName String
    Specifies the authentication provider that the object belongs to.
    queryForce Boolean
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    samAccountName String
    Specifies a user name.
    shell String
    Specifies a path to the shell for the user.
    sid String
    Specifies a security identifier. Cannot be updated.
    type String
    Specifies the object type.
    uid Double
    Specifies a numeric user identifier.
    unlock Boolean
    If true, the user account should be unlocked.
    upn String
    Specifies a principal name for the user.
    userCanChangePassword Boolean
    Specifies whether the password for the user can be changed.
    dn string
    Specifies a principal name for the user.
    dnsDomain string
    Specifies the DNS domain.
    domain string
    Specifies the domain that the object is part of. Cannot be updated.
    email string
    Specifies an email address.
    enabled boolean
    If true, the authenticated user is enabled.
    expired boolean
    If true, the authenticated user has expired.
    expiry number
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos string
    Specifies the GECOS value, which is usually the full name.
    generatedGid boolean
    If true, the GID was generated.
    generatedUid boolean
    If true, the UID was generated.
    generatedUpn boolean
    If true, the UPN was generated.
    gid UserGid
    Specifies a group identifier.
    homeDirectory string
    Specifies a home directory for the user.
    locked boolean
    If true, indicates that the account is locked.
    maxPasswordAge number
    Specifies the maximum time in seconds allowed before the password expires.
    name string
    Specifies a user name. Cannot be updated.
    password string
    Sets or Changes the password for the user.
    passwordExpired boolean
    If true, the password has expired.
    passwordExpires boolean
    If true, the password is allowed to expire.
    passwordExpiry number
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet number
    Specifies the last time the password was set.
    primaryGroup string
    Specifies the name of the primary group.
    primaryGroupSid UserPrimaryGroupSid
    Specifies the persona of the primary group.
    promptPasswordChange boolean
    If true, Prompts the user to change their password at the next login.
    providerName string
    Specifies the authentication provider that the object belongs to.
    queryForce boolean
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    queryProvider string
    Specifies the provider type. Cannot be updated.
    queryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    roles string[]
    List of roles, the user is assigned.
    samAccountName string
    Specifies a user name.
    shell string
    Specifies a path to the shell for the user.
    sid string
    Specifies a security identifier. Cannot be updated.
    type string
    Specifies the object type.
    uid number
    Specifies a numeric user identifier.
    unlock boolean
    If true, the user account should be unlocked.
    upn string
    Specifies a principal name for the user.
    userCanChangePassword boolean
    Specifies whether the password for the user can be changed.
    dn str
    Specifies a principal name for the user.
    dns_domain str
    Specifies the DNS domain.
    domain str
    Specifies the domain that the object is part of. Cannot be updated.
    email str
    Specifies an email address.
    enabled bool
    If true, the authenticated user is enabled.
    expired bool
    If true, the authenticated user has expired.
    expiry float
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos str
    Specifies the GECOS value, which is usually the full name.
    generated_gid bool
    If true, the GID was generated.
    generated_uid bool
    If true, the UID was generated.
    generated_upn bool
    If true, the UPN was generated.
    gid UserGidArgs
    Specifies a group identifier.
    home_directory str
    Specifies a home directory for the user.
    locked bool
    If true, indicates that the account is locked.
    max_password_age float
    Specifies the maximum time in seconds allowed before the password expires.
    name str
    Specifies a user name. Cannot be updated.
    password str
    Sets or Changes the password for the user.
    password_expired bool
    If true, the password has expired.
    password_expires bool
    If true, the password is allowed to expire.
    password_expiry float
    Specifies the time in Unix Epoch seconds that the password will expire.
    password_last_set float
    Specifies the last time the password was set.
    primary_group str
    Specifies the name of the primary group.
    primary_group_sid UserPrimaryGroupSidArgs
    Specifies the persona of the primary group.
    prompt_password_change bool
    If true, Prompts the user to change their password at the next login.
    provider_name str
    Specifies the authentication provider that the object belongs to.
    query_force bool
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    query_provider str
    Specifies the provider type. Cannot be updated.
    query_zone str
    Specifies the zone that the object belongs to. Cannot be updated.
    roles Sequence[str]
    List of roles, the user is assigned.
    sam_account_name str
    Specifies a user name.
    shell str
    Specifies a path to the shell for the user.
    sid str
    Specifies a security identifier. Cannot be updated.
    type str
    Specifies the object type.
    uid float
    Specifies a numeric user identifier.
    unlock bool
    If true, the user account should be unlocked.
    upn str
    Specifies a principal name for the user.
    user_can_change_password bool
    Specifies whether the password for the user can be changed.
    dn String
    Specifies a principal name for the user.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    email String
    Specifies an email address.
    enabled Boolean
    If true, the authenticated user is enabled.
    expired Boolean
    If true, the authenticated user has expired.
    expiry Number
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos String
    Specifies the GECOS value, which is usually the full name.
    generatedGid Boolean
    If true, the GID was generated.
    generatedUid Boolean
    If true, the UID was generated.
    generatedUpn Boolean
    If true, the UPN was generated.
    gid Property Map
    Specifies a group identifier.
    homeDirectory String
    Specifies a home directory for the user.
    locked Boolean
    If true, indicates that the account is locked.
    maxPasswordAge Number
    Specifies the maximum time in seconds allowed before the password expires.
    name String
    Specifies a user name. Cannot be updated.
    password String
    Sets or Changes the password for the user.
    passwordExpired Boolean
    If true, the password has expired.
    passwordExpires Boolean
    If true, the password is allowed to expire.
    passwordExpiry Number
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet Number
    Specifies the last time the password was set.
    primaryGroup String
    Specifies the name of the primary group.
    primaryGroupSid Property Map
    Specifies the persona of the primary group.
    promptPasswordChange Boolean
    If true, Prompts the user to change their password at the next login.
    providerName String
    Specifies the authentication provider that the object belongs to.
    queryForce Boolean
    If true, skip validation checks when creating user. Need to be true, when changing user UID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    samAccountName String
    Specifies a user name.
    shell String
    Specifies a path to the shell for the user.
    sid String
    Specifies a security identifier. Cannot be updated.
    type String
    Specifies the object type.
    uid Number
    Specifies a numeric user identifier.
    unlock Boolean
    If true, the user account should be unlocked.
    upn String
    Specifies a principal name for the user.
    userCanChangePassword Boolean
    Specifies whether the password for the user can be changed.

    Supporting Types

    UserGid, UserGidArgs

    Id string
    Name string
    Type string
    Id string
    Name string
    Type string
    id String
    name String
    type String
    id string
    name string
    type string
    id str
    name str
    type str
    id String
    name String
    type String

    UserPrimaryGroupSid, UserPrimaryGroupSidArgs

    Id string
    Name string
    Type string
    Id string
    Name string
    Type string
    id String
    name String
    type String
    id string
    name string
    type string
    id str
    name str
    type str
    id String
    name String
    type String

    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.

    The command is

    $ pulumi import powerscale:index/user:User testUser [<zoneID>:]<userName>

    Example1, is Optional, defaults to System:

    $ pulumi import powerscale:index/user:User testUser userName

    Example2:

    $ pulumi import powerscale:index/user:User testUser zoneID:userName

    after running this command, populate the name field and other required parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale