Class AuthConfigOpenLdap

Provides a Rancher v2 Auth Config OpenLdap resource. This can be used to configure and enable Auth Config OpenLdap for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Inheritance

System.Object

Resource

CustomResource

AuthConfigOpenLdap

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class AuthConfigOpenLdap : CustomResource

Constructors

AuthConfigOpenLdap(String, AuthConfigOpenLdapArgs, CustomResourceOptions)

Create a AuthConfigOpenLdap resource with the given unique name, arguments, and options.

Declaration

public AuthConfigOpenLdap(string name, AuthConfigOpenLdapArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthConfigOpenLdapArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccessMode

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

Declaration

public Output<string> AccessMode { get; }

Property Value

Type	Description
Output<System.String>

AllowedPrincipalIds

Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: openldap_user://<DN> openldap_group://<DN> (list)

Declaration

public Output<ImmutableArray<string>> AllowedPrincipalIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Annotations

Annotations of the resource (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Certificate

Base64 encoded CA certificate for TLS if self-signed. Use filebase64(<FILE>) for encoding file (string)

Declaration

public Output<string> Certificate { get; }

Property Value

Type	Description
Output<System.String>

ConnectionTimeout

OpenLdap connection timeout. Default 5000 (int)

Declaration

public Output<int?> ConnectionTimeout { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Enabled

Enable auth config provider. Default true (bool)

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

GroupDnAttribute

Group DN attribute. Default entryDN (string)

Declaration

public Output<string> GroupDnAttribute { get; }

Property Value

Type	Description
Output<System.String>

GroupMemberMappingAttribute

Group member mapping attribute. Default member (string)

Declaration

public Output<string> GroupMemberMappingAttribute { get; }

Property Value

Type	Description
Output<System.String>

GroupMemberUserAttribute

Group member user attribute. Default entryDN (string)

Declaration

public Output<string> GroupMemberUserAttribute { get; }

Property Value

Type	Description
Output<System.String>

GroupNameAttribute

Group name attribute. Default cn (string)

Declaration

public Output<string> GroupNameAttribute { get; }

Property Value

Type	Description
Output<System.String>

GroupObjectClass

Group object class. Default groupOfNames (string)

Declaration

public Output<string> GroupObjectClass { get; }

Property Value

Type	Description
Output<System.String>

GroupSearchAttribute

Group search attribute. Default cn (string)

Declaration

public Output<string> GroupSearchAttribute { get; }

Property Value

Type	Description
Output<System.String>

GroupSearchBase

Group search base (string)

Declaration

public Output<string> GroupSearchBase { get; }

Property Value

Type	Description
Output<System.String>

Labels

Labels of the resource (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

(Computed) The name of the resource (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NestedGroupMembershipEnabled

Nested group membership enable. Default false (bool)

Declaration

public Output<bool> NestedGroupMembershipEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

Port

OpenLdap port. Default 389 (int)

Declaration

public Output<int?> Port { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Servers

OpenLdap servers list (list)

Declaration

public Output<ImmutableArray<string>> Servers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ServiceAccountDistinguishedName

Service account DN for access OpenLdap service (string)

Declaration

public Output<string> ServiceAccountDistinguishedName { get; }

Property Value

Type	Description
Output<System.String>

ServiceAccountPassword

Service account password for access OpenLdap service (string)

Declaration

public Output<string> ServiceAccountPassword { get; }

Property Value

Type	Description
Output<System.String>

Tls

Enable TLS connection (bool)

Declaration

public Output<bool> Tls { get; }

Property Value

Type	Description
Output<System.Boolean>

Type

(Computed) The type of the resource (string)

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

UserDisabledBitMask

User disabled bit mask (int)

Declaration

public Output<int> UserDisabledBitMask { get; }

Property Value

Type	Description
Output<System.Int32>

UserEnabledAttribute

User enable attribute (string)

Declaration

public Output<string> UserEnabledAttribute { get; }

Property Value

Type	Description
Output<System.String>

UserLoginAttribute

User login attribute. Default uid (string)

Declaration

public Output<string> UserLoginAttribute { get; }

Property Value

Type	Description
Output<System.String>

UserMemberAttribute

User member attribute. Default memberOf (string)

Declaration

public Output<string> UserMemberAttribute { get; }

Property Value

Type	Description
Output<System.String>

UserNameAttribute

User name attribute. Default givenName (string)

Declaration

public Output<string> UserNameAttribute { get; }

Property Value

Type	Description
Output<System.String>

UserObjectClass

User object class. Default inetorgperson (string)

Declaration

public Output<string> UserObjectClass { get; }

Property Value

Type	Description
Output<System.String>

UserSearchAttribute

User search attribute. Default uid|sn|givenName (string)

Declaration

public Output<string> UserSearchAttribute { get; }

Property Value

Type	Description
Output<System.String>

UserSearchBase

User search base DN (string)

Declaration

public Output<string> UserSearchBase { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, AuthConfigOpenLdapState, CustomResourceOptions)

Get an existing AuthConfigOpenLdap resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static AuthConfigOpenLdap Get(string name, Input<string> id, AuthConfigOpenLdapState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthConfigOpenLdapState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthConfigOpenLdap