1. Packages
  2. Nsxt Provider
  3. API Docs
  4. NodeUser
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.NodeUser

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    Create NodeUser Resource

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

    Constructor syntax

    new NodeUser(name: string, args: NodeUserArgs, opts?: CustomResourceOptions);
    @overload
    def NodeUser(resource_name: str,
                 args: NodeUserArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def NodeUser(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 full_name: Optional[str] = None,
                 username: Optional[str] = None,
                 active: Optional[bool] = None,
                 node_user_id: Optional[str] = None,
                 password: Optional[str] = None,
                 password_change_frequency: Optional[float] = None,
                 password_change_warning: Optional[float] = None)
    func NewNodeUser(ctx *Context, name string, args NodeUserArgs, opts ...ResourceOption) (*NodeUser, error)
    public NodeUser(string name, NodeUserArgs args, CustomResourceOptions? opts = null)
    public NodeUser(String name, NodeUserArgs args)
    public NodeUser(String name, NodeUserArgs args, CustomResourceOptions options)
    
    type: nsxt:NodeUser
    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 NodeUserArgs
    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 NodeUserArgs
    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 NodeUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NodeUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NodeUserArgs
    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 nodeUserResource = new Nsxt.NodeUser("nodeUserResource", new()
    {
        FullName = "string",
        Username = "string",
        Active = false,
        NodeUserId = "string",
        Password = "string",
        PasswordChangeFrequency = 0,
        PasswordChangeWarning = 0,
    });
    
    example, err := nsxt.NewNodeUser(ctx, "nodeUserResource", &nsxt.NodeUserArgs{
    	FullName:                pulumi.String("string"),
    	Username:                pulumi.String("string"),
    	Active:                  pulumi.Bool(false),
    	NodeUserId:              pulumi.String("string"),
    	Password:                pulumi.String("string"),
    	PasswordChangeFrequency: pulumi.Float64(0),
    	PasswordChangeWarning:   pulumi.Float64(0),
    })
    
    var nodeUserResource = new NodeUser("nodeUserResource", NodeUserArgs.builder()
        .fullName("string")
        .username("string")
        .active(false)
        .nodeUserId("string")
        .password("string")
        .passwordChangeFrequency(0)
        .passwordChangeWarning(0)
        .build());
    
    node_user_resource = nsxt.NodeUser("nodeUserResource",
        full_name="string",
        username="string",
        active=False,
        node_user_id="string",
        password="string",
        password_change_frequency=0,
        password_change_warning=0)
    
    const nodeUserResource = new nsxt.NodeUser("nodeUserResource", {
        fullName: "string",
        username: "string",
        active: false,
        nodeUserId: "string",
        password: "string",
        passwordChangeFrequency: 0,
        passwordChangeWarning: 0,
    });
    
    type: nsxt:NodeUser
    properties:
        active: false
        fullName: string
        nodeUserId: string
        password: string
        passwordChangeFrequency: 0
        passwordChangeWarning: 0
        username: string
    

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

    FullName string
    The full name of this user.
    Username string
    User login name.
    Active bool
    If this account should be activated or deactivated. Default value is true.
    NodeUserId string
    Password string
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    PasswordChangeFrequency double
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    PasswordChangeWarning double
    Number of days before user receives warning message of password expiration.
    FullName string
    The full name of this user.
    Username string
    User login name.
    Active bool
    If this account should be activated or deactivated. Default value is true.
    NodeUserId string
    Password string
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    PasswordChangeFrequency float64
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    PasswordChangeWarning float64
    Number of days before user receives warning message of password expiration.
    fullName String
    The full name of this user.
    username String
    User login name.
    active Boolean
    If this account should be activated or deactivated. Default value is true.
    nodeUserId String
    password String
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    passwordChangeFrequency Double
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    passwordChangeWarning Double
    Number of days before user receives warning message of password expiration.
    fullName string
    The full name of this user.
    username string
    User login name.
    active boolean
    If this account should be activated or deactivated. Default value is true.
    nodeUserId string
    password string
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    passwordChangeFrequency number
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    passwordChangeWarning number
    Number of days before user receives warning message of password expiration.
    full_name str
    The full name of this user.
    username str
    User login name.
    active bool
    If this account should be activated or deactivated. Default value is true.
    node_user_id str
    password str
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    password_change_frequency float
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    password_change_warning float
    Number of days before user receives warning message of password expiration.
    fullName String
    The full name of this user.
    username String
    User login name.
    active Boolean
    If this account should be activated or deactivated. Default value is true.
    nodeUserId String
    password String
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    passwordChangeFrequency Number
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    passwordChangeWarning Number
    Number of days before user receives warning message of password expiration.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LastPasswordChange double
    Number of days since password was last changed.
    PasswordResetRequired bool
    Boolean value that states if a password reset is required.
    Status string
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    UserId double
    Numeric id for the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastPasswordChange float64
    Number of days since password was last changed.
    PasswordResetRequired bool
    Boolean value that states if a password reset is required.
    Status string
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    UserId float64
    Numeric id for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    lastPasswordChange Double
    Number of days since password was last changed.
    passwordResetRequired Boolean
    Boolean value that states if a password reset is required.
    status String
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    userId Double
    Numeric id for the user.
    id string
    The provider-assigned unique ID for this managed resource.
    lastPasswordChange number
    Number of days since password was last changed.
    passwordResetRequired boolean
    Boolean value that states if a password reset is required.
    status string
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    userId number
    Numeric id for the user.
    id str
    The provider-assigned unique ID for this managed resource.
    last_password_change float
    Number of days since password was last changed.
    password_reset_required bool
    Boolean value that states if a password reset is required.
    status str
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    user_id float
    Numeric id for the user.
    id String
    The provider-assigned unique ID for this managed resource.
    lastPasswordChange Number
    Number of days since password was last changed.
    passwordResetRequired Boolean
    Boolean value that states if a password reset is required.
    status String
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    userId Number
    Numeric id for the user.

    Look up Existing NodeUser Resource

    Get an existing NodeUser 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?: NodeUserState, opts?: CustomResourceOptions): NodeUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            active: Optional[bool] = None,
            full_name: Optional[str] = None,
            last_password_change: Optional[float] = None,
            node_user_id: Optional[str] = None,
            password: Optional[str] = None,
            password_change_frequency: Optional[float] = None,
            password_change_warning: Optional[float] = None,
            password_reset_required: Optional[bool] = None,
            status: Optional[str] = None,
            user_id: Optional[float] = None,
            username: Optional[str] = None) -> NodeUser
    func GetNodeUser(ctx *Context, name string, id IDInput, state *NodeUserState, opts ...ResourceOption) (*NodeUser, error)
    public static NodeUser Get(string name, Input<string> id, NodeUserState? state, CustomResourceOptions? opts = null)
    public static NodeUser get(String name, Output<String> id, NodeUserState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:NodeUser    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:
    Active bool
    If this account should be activated or deactivated. Default value is true.
    FullName string
    The full name of this user.
    LastPasswordChange double
    Number of days since password was last changed.
    NodeUserId string
    Password string
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    PasswordChangeFrequency double
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    PasswordChangeWarning double
    Number of days before user receives warning message of password expiration.
    PasswordResetRequired bool
    Boolean value that states if a password reset is required.
    Status string
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    UserId double
    Numeric id for the user.
    Username string
    User login name.
    Active bool
    If this account should be activated or deactivated. Default value is true.
    FullName string
    The full name of this user.
    LastPasswordChange float64
    Number of days since password was last changed.
    NodeUserId string
    Password string
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    PasswordChangeFrequency float64
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    PasswordChangeWarning float64
    Number of days before user receives warning message of password expiration.
    PasswordResetRequired bool
    Boolean value that states if a password reset is required.
    Status string
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    UserId float64
    Numeric id for the user.
    Username string
    User login name.
    active Boolean
    If this account should be activated or deactivated. Default value is true.
    fullName String
    The full name of this user.
    lastPasswordChange Double
    Number of days since password was last changed.
    nodeUserId String
    password String
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    passwordChangeFrequency Double
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    passwordChangeWarning Double
    Number of days before user receives warning message of password expiration.
    passwordResetRequired Boolean
    Boolean value that states if a password reset is required.
    status String
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    userId Double
    Numeric id for the user.
    username String
    User login name.
    active boolean
    If this account should be activated or deactivated. Default value is true.
    fullName string
    The full name of this user.
    lastPasswordChange number
    Number of days since password was last changed.
    nodeUserId string
    password string
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    passwordChangeFrequency number
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    passwordChangeWarning number
    Number of days before user receives warning message of password expiration.
    passwordResetRequired boolean
    Boolean value that states if a password reset is required.
    status string
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    userId number
    Numeric id for the user.
    username string
    User login name.
    active bool
    If this account should be activated or deactivated. Default value is true.
    full_name str
    The full name of this user.
    last_password_change float
    Number of days since password was last changed.
    node_user_id str
    password str
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    password_change_frequency float
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    password_change_warning float
    Number of days before user receives warning message of password expiration.
    password_reset_required bool
    Boolean value that states if a password reset is required.
    status str
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    user_id float
    Numeric id for the user.
    username str
    User login name.
    active Boolean
    If this account should be activated or deactivated. Default value is true.
    fullName String
    The full name of this user.
    lastPasswordChange Number
    Number of days since password was last changed.
    nodeUserId String
    password String
    Password of this user. Password must be specified for creating ACTIVE accounts. Password updates will only take effect after deactivating the account, then reactivating it.
    passwordChangeFrequency Number
    Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.
    passwordChangeWarning Number
    Number of days before user receives warning message of password expiration.
    passwordResetRequired Boolean
    Boolean value that states if a password reset is required.
    status String
    Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.
    userId Number
    Numeric id for the user.
    username String
    User login name.

    Package Details

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