New-PveAccessDomains

SYNOPSIS

SYNTAX

New-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [[-Autocreate] <Boolean>]
 [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [[-CaseSensitive] <Boolean>] [[-Cert] <String>]
 [[-Certkey] <String>] [[-CheckConnection] <Boolean>] [[-ClientId] <String>] [[-ClientKey] <String>]
 [[-Comment] <String>] [[-Default] <Boolean>] [[-Domain] <String>] [[-Filter] <String>]
 [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>]
 [[-GroupsAutocreate] <Boolean>] [[-GroupsClaim] <String>] [[-GroupsOverwrite] <Boolean>]
 [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>]
 [[-QueryUserinfo] <Boolean>] [-Realm] <String> [[-Scopes] <String>] [[-Secure] <Boolean>]
 [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>]
 [[-SyncAttributes] <String>] [[-Tfa] <String>] [-Type] <String> [[-UserAttr] <String>]
 [[-UserClasses] <String>] [[-UsernameClaim] <String>] [[-Verify] <Boolean>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Add an authentication server.

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-PveTicket

Ticket data connection.

Type: PveTicket
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AcrValues

Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Autocreate

Automatically create users if they do not exist.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-BaseDn

LDAP base domain name

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-BindDn

LDAP bind domain name

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Capath

Path to the CA certificate store

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CaseSensitive

username is case-sensitive

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Cert

Path to the client certificate

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Certkey

Path to the client certificate key

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CheckConnection

Check bind connection to the server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ClientId

OpenID Client ID

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ClientKey

OpenID Client Key

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Comment

Description.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Default

Use this as default realm

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Domain

AD domain name

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Filter

LDAP filter for user sync.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupClasses

The objectclasses for groups.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupDn

LDAP base domain name for group sync. If not set, the base_dn will be used.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupFilter

LDAP filter for group sync.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupNameAttr

LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupsAutocreate

Automatically create groups if they do not exist.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupsClaim

OpenID claim used to retrieve groups with.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-GroupsOverwrite

All groups will be overwritten for the user on login.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IssuerUrl

OpenID Issuer Url

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Mode

LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Password

LDAP bind password. Will be stored in '/etc/pve/priv/realm/\<REALM>.pw'.

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Port

Server port.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Prompt

Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-QueryUserinfo

Enables querying the userinfo endpoint for claims values.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Realm

Authentication domain ID

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 30
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Scopes

Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Secure

Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Server1

Server IP address (or DNS name)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Server2

Fallback Server IP address (or DNS name)

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Sslversion

LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 35
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SyncDefaultsOptions

The default options for behavior of synchronizations.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 36
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SyncAttributes

Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 37
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Tfa

Use Two-factor authentication.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 38
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Type

Realm type. Enum: ad,ldap,openid,pam,pve

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 39
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserAttr

LDAP user attribute name

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 40
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserClasses

The objectclasses for users.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 41
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UsernameClaim

OpenID claim used to generate the unique username.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 42
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Verify

Verify the server's SSL certificate

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 43
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

PveResponse. Return response.

NOTES

RELATED LINKS