Share via


LinuxUserConfiguration Class

Properties used to create a user account on a Linux node.

Constructor

LinuxUserConfiguration(*, uid: int | None = None, gid: int | None = None, ssh_private_key: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
uid
int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

Default value: None
gid
int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

Default value: None
ssh_private_key
str

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).

Default value: None

Variables

Name Description
uid
int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.

gid
int

The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.

ssh_private_key
str

The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).