rancher2.ActiveDirectory
Explore with Pulumi AI
Deprecated:
rancher2.ActiveDirectory has been deprecated in favor of rancher2.AuthConfigActiveDirectory
Provides a Rancher v2 Auth Config ActiveDirectory resource. This can be used to configure and enable Auth Config ActiveDirectory 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.
Create ActiveDirectory Resource
new ActiveDirectory(name: string, args: ActiveDirectoryArgs, opts?: CustomResourceOptions);
@overload
def ActiveDirectory(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_mode: Optional[str] = None,
allowed_principal_ids: Optional[Sequence[str]] = None,
annotations: Optional[Mapping[str, Any]] = None,
certificate: Optional[str] = None,
connection_timeout: Optional[int] = None,
default_login_domain: Optional[str] = None,
enabled: Optional[bool] = None,
group_dn_attribute: Optional[str] = None,
group_member_mapping_attribute: Optional[str] = None,
group_member_user_attribute: Optional[str] = None,
group_name_attribute: Optional[str] = None,
group_object_class: Optional[str] = None,
group_search_attribute: Optional[str] = None,
group_search_base: Optional[str] = None,
group_search_filter: Optional[str] = None,
labels: Optional[Mapping[str, Any]] = None,
nested_group_membership_enabled: Optional[bool] = None,
port: Optional[int] = None,
servers: Optional[Sequence[str]] = None,
service_account_password: Optional[str] = None,
service_account_username: Optional[str] = None,
start_tls: Optional[bool] = None,
test_password: Optional[str] = None,
test_username: Optional[str] = None,
tls: Optional[bool] = None,
user_disabled_bit_mask: Optional[int] = None,
user_enabled_attribute: Optional[str] = None,
user_login_attribute: Optional[str] = None,
user_name_attribute: Optional[str] = None,
user_object_class: Optional[str] = None,
user_search_attribute: Optional[str] = None,
user_search_base: Optional[str] = None,
user_search_filter: Optional[str] = None)
@overload
def ActiveDirectory(resource_name: str,
args: ActiveDirectoryArgs,
opts: Optional[ResourceOptions] = None)
func NewActiveDirectory(ctx *Context, name string, args ActiveDirectoryArgs, opts ...ResourceOption) (*ActiveDirectory, error)
public ActiveDirectory(string name, ActiveDirectoryArgs args, CustomResourceOptions? opts = null)
public ActiveDirectory(String name, ActiveDirectoryArgs args)
public ActiveDirectory(String name, ActiveDirectoryArgs args, CustomResourceOptions options)
type: rancher2:ActiveDirectory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActiveDirectoryArgs
- 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 ActiveDirectoryArgs
- 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 ActiveDirectoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActiveDirectoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ActiveDirectoryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ActiveDirectory Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ActiveDirectory resource accepts the following input properties:
- Servers List<string>
ActiveDirectory servers list (list)
- Service
Account stringPassword Service account password for access ActiveDirectory service (string)
- Service
Account stringUsername Service account DN for access ActiveDirectory service (string)
- Test
Password string Password for test access to ActiveDirectory service (string)
- Test
Username string Username for test access to ActiveDirectory service (string)
- User
Search stringBase User search base DN (string)
- Access
Mode string Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- Allowed
Principal List<string>Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- Annotations Dictionary<string, object>
Annotations of the resource (map)
- Certificate string
CA certificate for TLS if selfsigned (string)
- Connection
Timeout int ActiveDirectory connection timeout. Default
5000
(int)- Default
Login stringDomain ActiveDirectory defult login domain (string)
- Enabled bool
Enable auth config provider. Default
true
(bool)- Group
Dn stringAttribute Group DN attribute. Default
distinguishedName
(string)- Group
Member stringMapping Attribute Group member mapping attribute. Default
member
(string)- Group
Member stringUser Attribute Group member user attribute. Default
distinguishedName
(string)- Group
Name stringAttribute Group name attribute. Default
name
(string)- Group
Object stringClass Group object class. Default
group
(string)- Group
Search stringAttribute Group search attribute. Default
sAMAccountName
(string)- Group
Search stringBase Group search base (string)
- Group
Search stringFilter Group search filter (string)
- Labels Dictionary<string, object>
Labels of the resource (map)
- Nested
Group boolMembership Enabled Nested group membership enable. Default
false
(bool)- Port int
ActiveDirectory port. Default
389
(int)- Start
Tls bool Enable start TLS connection (bool)
- Tls bool
Enable TLS connection (bool)
- User
Disabled intBit Mask User disabled bit mask. Default
2
(int)- User
Enabled stringAttribute User enable attribute (string)
- User
Login stringAttribute User login attribute. Default
sAMAccountName
(string)- User
Name stringAttribute User name attribute. Default
name
(string)- User
Object stringClass User object class. Default
person
(string)- User
Search stringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- User
Search stringFilter User search filter (string)
- Servers []string
ActiveDirectory servers list (list)
- Service
Account stringPassword Service account password for access ActiveDirectory service (string)
- Service
Account stringUsername Service account DN for access ActiveDirectory service (string)
- Test
Password string Password for test access to ActiveDirectory service (string)
- Test
Username string Username for test access to ActiveDirectory service (string)
- User
Search stringBase User search base DN (string)
- Access
Mode string Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- Allowed
Principal []stringIds Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- Annotations map[string]interface{}
Annotations of the resource (map)
- Certificate string
CA certificate for TLS if selfsigned (string)
- Connection
Timeout int ActiveDirectory connection timeout. Default
5000
(int)- Default
Login stringDomain ActiveDirectory defult login domain (string)
- Enabled bool
Enable auth config provider. Default
true
(bool)- Group
Dn stringAttribute Group DN attribute. Default
distinguishedName
(string)- Group
Member stringMapping Attribute Group member mapping attribute. Default
member
(string)- Group
Member stringUser Attribute Group member user attribute. Default
distinguishedName
(string)- Group
Name stringAttribute Group name attribute. Default
name
(string)- Group
Object stringClass Group object class. Default
group
(string)- Group
Search stringAttribute Group search attribute. Default
sAMAccountName
(string)- Group
Search stringBase Group search base (string)
- Group
Search stringFilter Group search filter (string)
- Labels map[string]interface{}
Labels of the resource (map)
- Nested
Group boolMembership Enabled Nested group membership enable. Default
false
(bool)- Port int
ActiveDirectory port. Default
389
(int)- Start
Tls bool Enable start TLS connection (bool)
- Tls bool
Enable TLS connection (bool)
- User
Disabled intBit Mask User disabled bit mask. Default
2
(int)- User
Enabled stringAttribute User enable attribute (string)
- User
Login stringAttribute User login attribute. Default
sAMAccountName
(string)- User
Name stringAttribute User name attribute. Default
name
(string)- User
Object stringClass User object class. Default
person
(string)- User
Search stringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- User
Search stringFilter User search filter (string)
- servers List<String>
ActiveDirectory servers list (list)
- service
Account StringPassword Service account password for access ActiveDirectory service (string)
- service
Account StringUsername Service account DN for access ActiveDirectory service (string)
- test
Password String Password for test access to ActiveDirectory service (string)
- test
Username String Username for test access to ActiveDirectory service (string)
- user
Search StringBase User search base DN (string)
- access
Mode String Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed
Principal List<String>Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations Map<String,Object>
Annotations of the resource (map)
- certificate String
CA certificate for TLS if selfsigned (string)
- connection
Timeout Integer ActiveDirectory connection timeout. Default
5000
(int)- default
Login StringDomain ActiveDirectory defult login domain (string)
- enabled Boolean
Enable auth config provider. Default
true
(bool)- group
Dn StringAttribute Group DN attribute. Default
distinguishedName
(string)- group
Member StringMapping Attribute Group member mapping attribute. Default
member
(string)- group
Member StringUser Attribute Group member user attribute. Default
distinguishedName
(string)- group
Name StringAttribute Group name attribute. Default
name
(string)- group
Object StringClass Group object class. Default
group
(string)- group
Search StringAttribute Group search attribute. Default
sAMAccountName
(string)- group
Search StringBase Group search base (string)
- group
Search StringFilter Group search filter (string)
- labels Map<String,Object>
Labels of the resource (map)
- nested
Group BooleanMembership Enabled Nested group membership enable. Default
false
(bool)- port Integer
ActiveDirectory port. Default
389
(int)- start
Tls Boolean Enable start TLS connection (bool)
- tls Boolean
Enable TLS connection (bool)
- user
Disabled IntegerBit Mask User disabled bit mask. Default
2
(int)- user
Enabled StringAttribute User enable attribute (string)
- user
Login StringAttribute User login attribute. Default
sAMAccountName
(string)- user
Name StringAttribute User name attribute. Default
name
(string)- user
Object StringClass User object class. Default
person
(string)- user
Search StringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user
Search StringFilter User search filter (string)
- servers string[]
ActiveDirectory servers list (list)
- service
Account stringPassword Service account password for access ActiveDirectory service (string)
- service
Account stringUsername Service account DN for access ActiveDirectory service (string)
- test
Password string Password for test access to ActiveDirectory service (string)
- test
Username string Username for test access to ActiveDirectory service (string)
- user
Search stringBase User search base DN (string)
- access
Mode string Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed
Principal string[]Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations {[key: string]: any}
Annotations of the resource (map)
- certificate string
CA certificate for TLS if selfsigned (string)
- connection
Timeout number ActiveDirectory connection timeout. Default
5000
(int)- default
Login stringDomain ActiveDirectory defult login domain (string)
- enabled boolean
Enable auth config provider. Default
true
(bool)- group
Dn stringAttribute Group DN attribute. Default
distinguishedName
(string)- group
Member stringMapping Attribute Group member mapping attribute. Default
member
(string)- group
Member stringUser Attribute Group member user attribute. Default
distinguishedName
(string)- group
Name stringAttribute Group name attribute. Default
name
(string)- group
Object stringClass Group object class. Default
group
(string)- group
Search stringAttribute Group search attribute. Default
sAMAccountName
(string)- group
Search stringBase Group search base (string)
- group
Search stringFilter Group search filter (string)
- labels {[key: string]: any}
Labels of the resource (map)
- nested
Group booleanMembership Enabled Nested group membership enable. Default
false
(bool)- port number
ActiveDirectory port. Default
389
(int)- start
Tls boolean Enable start TLS connection (bool)
- tls boolean
Enable TLS connection (bool)
- user
Disabled numberBit Mask User disabled bit mask. Default
2
(int)- user
Enabled stringAttribute User enable attribute (string)
- user
Login stringAttribute User login attribute. Default
sAMAccountName
(string)- user
Name stringAttribute User name attribute. Default
name
(string)- user
Object stringClass User object class. Default
person
(string)- user
Search stringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user
Search stringFilter User search filter (string)
- servers Sequence[str]
ActiveDirectory servers list (list)
- service_
account_ strpassword Service account password for access ActiveDirectory service (string)
- service_
account_ strusername Service account DN for access ActiveDirectory service (string)
- test_
password str Password for test access to ActiveDirectory service (string)
- test_
username str Username for test access to ActiveDirectory service (string)
- user_
search_ strbase User search base DN (string)
- access_
mode str Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed_
principal_ Sequence[str]ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations Mapping[str, Any]
Annotations of the resource (map)
- certificate str
CA certificate for TLS if selfsigned (string)
- connection_
timeout int ActiveDirectory connection timeout. Default
5000
(int)- default_
login_ strdomain ActiveDirectory defult login domain (string)
- enabled bool
Enable auth config provider. Default
true
(bool)- group_
dn_ strattribute Group DN attribute. Default
distinguishedName
(string)- group_
member_ strmapping_ attribute Group member mapping attribute. Default
member
(string)- group_
member_ struser_ attribute Group member user attribute. Default
distinguishedName
(string)- group_
name_ strattribute Group name attribute. Default
name
(string)- group_
object_ strclass Group object class. Default
group
(string)- group_
search_ strattribute Group search attribute. Default
sAMAccountName
(string)- group_
search_ strbase Group search base (string)
- group_
search_ strfilter Group search filter (string)
- labels Mapping[str, Any]
Labels of the resource (map)
- nested_
group_ boolmembership_ enabled Nested group membership enable. Default
false
(bool)- port int
ActiveDirectory port. Default
389
(int)- start_
tls bool Enable start TLS connection (bool)
- tls bool
Enable TLS connection (bool)
- user_
disabled_ intbit_ mask User disabled bit mask. Default
2
(int)- user_
enabled_ strattribute User enable attribute (string)
- user_
login_ strattribute User login attribute. Default
sAMAccountName
(string)- user_
name_ strattribute User name attribute. Default
name
(string)- user_
object_ strclass User object class. Default
person
(string)- user_
search_ strattribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user_
search_ strfilter User search filter (string)
- servers List<String>
ActiveDirectory servers list (list)
- service
Account StringPassword Service account password for access ActiveDirectory service (string)
- service
Account StringUsername Service account DN for access ActiveDirectory service (string)
- test
Password String Password for test access to ActiveDirectory service (string)
- test
Username String Username for test access to ActiveDirectory service (string)
- user
Search StringBase User search base DN (string)
- access
Mode String Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed
Principal List<String>Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations Map<Any>
Annotations of the resource (map)
- certificate String
CA certificate for TLS if selfsigned (string)
- connection
Timeout Number ActiveDirectory connection timeout. Default
5000
(int)- default
Login StringDomain ActiveDirectory defult login domain (string)
- enabled Boolean
Enable auth config provider. Default
true
(bool)- group
Dn StringAttribute Group DN attribute. Default
distinguishedName
(string)- group
Member StringMapping Attribute Group member mapping attribute. Default
member
(string)- group
Member StringUser Attribute Group member user attribute. Default
distinguishedName
(string)- group
Name StringAttribute Group name attribute. Default
name
(string)- group
Object StringClass Group object class. Default
group
(string)- group
Search StringAttribute Group search attribute. Default
sAMAccountName
(string)- group
Search StringBase Group search base (string)
- group
Search StringFilter Group search filter (string)
- labels Map<Any>
Labels of the resource (map)
- nested
Group BooleanMembership Enabled Nested group membership enable. Default
false
(bool)- port Number
ActiveDirectory port. Default
389
(int)- start
Tls Boolean Enable start TLS connection (bool)
- tls Boolean
Enable TLS connection (bool)
- user
Disabled NumberBit Mask User disabled bit mask. Default
2
(int)- user
Enabled StringAttribute User enable attribute (string)
- user
Login StringAttribute User login attribute. Default
sAMAccountName
(string)- user
Name StringAttribute User name attribute. Default
name
(string)- user
Object StringClass User object class. Default
person
(string)- user
Search StringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user
Search StringFilter User search filter (string)
Outputs
All input properties are implicitly available as output properties. Additionally, the ActiveDirectory resource produces the following output properties:
Look up Existing ActiveDirectory Resource
Get an existing ActiveDirectory 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?: ActiveDirectoryState, opts?: CustomResourceOptions): ActiveDirectory
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_mode: Optional[str] = None,
allowed_principal_ids: Optional[Sequence[str]] = None,
annotations: Optional[Mapping[str, Any]] = None,
certificate: Optional[str] = None,
connection_timeout: Optional[int] = None,
default_login_domain: Optional[str] = None,
enabled: Optional[bool] = None,
group_dn_attribute: Optional[str] = None,
group_member_mapping_attribute: Optional[str] = None,
group_member_user_attribute: Optional[str] = None,
group_name_attribute: Optional[str] = None,
group_object_class: Optional[str] = None,
group_search_attribute: Optional[str] = None,
group_search_base: Optional[str] = None,
group_search_filter: Optional[str] = None,
labels: Optional[Mapping[str, Any]] = None,
name: Optional[str] = None,
nested_group_membership_enabled: Optional[bool] = None,
port: Optional[int] = None,
servers: Optional[Sequence[str]] = None,
service_account_password: Optional[str] = None,
service_account_username: Optional[str] = None,
start_tls: Optional[bool] = None,
test_password: Optional[str] = None,
test_username: Optional[str] = None,
tls: Optional[bool] = None,
type: Optional[str] = None,
user_disabled_bit_mask: Optional[int] = None,
user_enabled_attribute: Optional[str] = None,
user_login_attribute: Optional[str] = None,
user_name_attribute: Optional[str] = None,
user_object_class: Optional[str] = None,
user_search_attribute: Optional[str] = None,
user_search_base: Optional[str] = None,
user_search_filter: Optional[str] = None) -> ActiveDirectory
func GetActiveDirectory(ctx *Context, name string, id IDInput, state *ActiveDirectoryState, opts ...ResourceOption) (*ActiveDirectory, error)
public static ActiveDirectory Get(string name, Input<string> id, ActiveDirectoryState? state, CustomResourceOptions? opts = null)
public static ActiveDirectory get(String name, Output<String> id, ActiveDirectoryState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Access
Mode string Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- Allowed
Principal List<string>Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- Annotations Dictionary<string, object>
Annotations of the resource (map)
- Certificate string
CA certificate for TLS if selfsigned (string)
- Connection
Timeout int ActiveDirectory connection timeout. Default
5000
(int)- Default
Login stringDomain ActiveDirectory defult login domain (string)
- Enabled bool
Enable auth config provider. Default
true
(bool)- Group
Dn stringAttribute Group DN attribute. Default
distinguishedName
(string)- Group
Member stringMapping Attribute Group member mapping attribute. Default
member
(string)- Group
Member stringUser Attribute Group member user attribute. Default
distinguishedName
(string)- Group
Name stringAttribute Group name attribute. Default
name
(string)- Group
Object stringClass Group object class. Default
group
(string)- Group
Search stringAttribute Group search attribute. Default
sAMAccountName
(string)- Group
Search stringBase Group search base (string)
- Group
Search stringFilter Group search filter (string)
- Labels Dictionary<string, object>
Labels of the resource (map)
- Name string
(Computed) The name of the resource (string)
- Nested
Group boolMembership Enabled Nested group membership enable. Default
false
(bool)- Port int
ActiveDirectory port. Default
389
(int)- Servers List<string>
ActiveDirectory servers list (list)
- Service
Account stringPassword Service account password for access ActiveDirectory service (string)
- Service
Account stringUsername Service account DN for access ActiveDirectory service (string)
- Start
Tls bool Enable start TLS connection (bool)
- Test
Password string Password for test access to ActiveDirectory service (string)
- Test
Username string Username for test access to ActiveDirectory service (string)
- Tls bool
Enable TLS connection (bool)
- Type string
(Computed) The type of the resource (string)
- User
Disabled intBit Mask User disabled bit mask. Default
2
(int)- User
Enabled stringAttribute User enable attribute (string)
- User
Login stringAttribute User login attribute. Default
sAMAccountName
(string)- User
Name stringAttribute User name attribute. Default
name
(string)- User
Object stringClass User object class. Default
person
(string)- User
Search stringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- User
Search stringBase User search base DN (string)
- User
Search stringFilter User search filter (string)
- Access
Mode string Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- Allowed
Principal []stringIds Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- Annotations map[string]interface{}
Annotations of the resource (map)
- Certificate string
CA certificate for TLS if selfsigned (string)
- Connection
Timeout int ActiveDirectory connection timeout. Default
5000
(int)- Default
Login stringDomain ActiveDirectory defult login domain (string)
- Enabled bool
Enable auth config provider. Default
true
(bool)- Group
Dn stringAttribute Group DN attribute. Default
distinguishedName
(string)- Group
Member stringMapping Attribute Group member mapping attribute. Default
member
(string)- Group
Member stringUser Attribute Group member user attribute. Default
distinguishedName
(string)- Group
Name stringAttribute Group name attribute. Default
name
(string)- Group
Object stringClass Group object class. Default
group
(string)- Group
Search stringAttribute Group search attribute. Default
sAMAccountName
(string)- Group
Search stringBase Group search base (string)
- Group
Search stringFilter Group search filter (string)
- Labels map[string]interface{}
Labels of the resource (map)
- Name string
(Computed) The name of the resource (string)
- Nested
Group boolMembership Enabled Nested group membership enable. Default
false
(bool)- Port int
ActiveDirectory port. Default
389
(int)- Servers []string
ActiveDirectory servers list (list)
- Service
Account stringPassword Service account password for access ActiveDirectory service (string)
- Service
Account stringUsername Service account DN for access ActiveDirectory service (string)
- Start
Tls bool Enable start TLS connection (bool)
- Test
Password string Password for test access to ActiveDirectory service (string)
- Test
Username string Username for test access to ActiveDirectory service (string)
- Tls bool
Enable TLS connection (bool)
- Type string
(Computed) The type of the resource (string)
- User
Disabled intBit Mask User disabled bit mask. Default
2
(int)- User
Enabled stringAttribute User enable attribute (string)
- User
Login stringAttribute User login attribute. Default
sAMAccountName
(string)- User
Name stringAttribute User name attribute. Default
name
(string)- User
Object stringClass User object class. Default
person
(string)- User
Search stringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- User
Search stringBase User search base DN (string)
- User
Search stringFilter User search filter (string)
- access
Mode String Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed
Principal List<String>Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations Map<String,Object>
Annotations of the resource (map)
- certificate String
CA certificate for TLS if selfsigned (string)
- connection
Timeout Integer ActiveDirectory connection timeout. Default
5000
(int)- default
Login StringDomain ActiveDirectory defult login domain (string)
- enabled Boolean
Enable auth config provider. Default
true
(bool)- group
Dn StringAttribute Group DN attribute. Default
distinguishedName
(string)- group
Member StringMapping Attribute Group member mapping attribute. Default
member
(string)- group
Member StringUser Attribute Group member user attribute. Default
distinguishedName
(string)- group
Name StringAttribute Group name attribute. Default
name
(string)- group
Object StringClass Group object class. Default
group
(string)- group
Search StringAttribute Group search attribute. Default
sAMAccountName
(string)- group
Search StringBase Group search base (string)
- group
Search StringFilter Group search filter (string)
- labels Map<String,Object>
Labels of the resource (map)
- name String
(Computed) The name of the resource (string)
- nested
Group BooleanMembership Enabled Nested group membership enable. Default
false
(bool)- port Integer
ActiveDirectory port. Default
389
(int)- servers List<String>
ActiveDirectory servers list (list)
- service
Account StringPassword Service account password for access ActiveDirectory service (string)
- service
Account StringUsername Service account DN for access ActiveDirectory service (string)
- start
Tls Boolean Enable start TLS connection (bool)
- test
Password String Password for test access to ActiveDirectory service (string)
- test
Username String Username for test access to ActiveDirectory service (string)
- tls Boolean
Enable TLS connection (bool)
- type String
(Computed) The type of the resource (string)
- user
Disabled IntegerBit Mask User disabled bit mask. Default
2
(int)- user
Enabled StringAttribute User enable attribute (string)
- user
Login StringAttribute User login attribute. Default
sAMAccountName
(string)- user
Name StringAttribute User name attribute. Default
name
(string)- user
Object StringClass User object class. Default
person
(string)- user
Search StringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user
Search StringBase User search base DN (string)
- user
Search StringFilter User search filter (string)
- access
Mode string Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed
Principal string[]Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations {[key: string]: any}
Annotations of the resource (map)
- certificate string
CA certificate for TLS if selfsigned (string)
- connection
Timeout number ActiveDirectory connection timeout. Default
5000
(int)- default
Login stringDomain ActiveDirectory defult login domain (string)
- enabled boolean
Enable auth config provider. Default
true
(bool)- group
Dn stringAttribute Group DN attribute. Default
distinguishedName
(string)- group
Member stringMapping Attribute Group member mapping attribute. Default
member
(string)- group
Member stringUser Attribute Group member user attribute. Default
distinguishedName
(string)- group
Name stringAttribute Group name attribute. Default
name
(string)- group
Object stringClass Group object class. Default
group
(string)- group
Search stringAttribute Group search attribute. Default
sAMAccountName
(string)- group
Search stringBase Group search base (string)
- group
Search stringFilter Group search filter (string)
- labels {[key: string]: any}
Labels of the resource (map)
- name string
(Computed) The name of the resource (string)
- nested
Group booleanMembership Enabled Nested group membership enable. Default
false
(bool)- port number
ActiveDirectory port. Default
389
(int)- servers string[]
ActiveDirectory servers list (list)
- service
Account stringPassword Service account password for access ActiveDirectory service (string)
- service
Account stringUsername Service account DN for access ActiveDirectory service (string)
- start
Tls boolean Enable start TLS connection (bool)
- test
Password string Password for test access to ActiveDirectory service (string)
- test
Username string Username for test access to ActiveDirectory service (string)
- tls boolean
Enable TLS connection (bool)
- type string
(Computed) The type of the resource (string)
- user
Disabled numberBit Mask User disabled bit mask. Default
2
(int)- user
Enabled stringAttribute User enable attribute (string)
- user
Login stringAttribute User login attribute. Default
sAMAccountName
(string)- user
Name stringAttribute User name attribute. Default
name
(string)- user
Object stringClass User object class. Default
person
(string)- user
Search stringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user
Search stringBase User search base DN (string)
- user
Search stringFilter User search filter (string)
- access_
mode str Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed_
principal_ Sequence[str]ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations Mapping[str, Any]
Annotations of the resource (map)
- certificate str
CA certificate for TLS if selfsigned (string)
- connection_
timeout int ActiveDirectory connection timeout. Default
5000
(int)- default_
login_ strdomain ActiveDirectory defult login domain (string)
- enabled bool
Enable auth config provider. Default
true
(bool)- group_
dn_ strattribute Group DN attribute. Default
distinguishedName
(string)- group_
member_ strmapping_ attribute Group member mapping attribute. Default
member
(string)- group_
member_ struser_ attribute Group member user attribute. Default
distinguishedName
(string)- group_
name_ strattribute Group name attribute. Default
name
(string)- group_
object_ strclass Group object class. Default
group
(string)- group_
search_ strattribute Group search attribute. Default
sAMAccountName
(string)- group_
search_ strbase Group search base (string)
- group_
search_ strfilter Group search filter (string)
- labels Mapping[str, Any]
Labels of the resource (map)
- name str
(Computed) The name of the resource (string)
- nested_
group_ boolmembership_ enabled Nested group membership enable. Default
false
(bool)- port int
ActiveDirectory port. Default
389
(int)- servers Sequence[str]
ActiveDirectory servers list (list)
- service_
account_ strpassword Service account password for access ActiveDirectory service (string)
- service_
account_ strusername Service account DN for access ActiveDirectory service (string)
- start_
tls bool Enable start TLS connection (bool)
- test_
password str Password for test access to ActiveDirectory service (string)
- test_
username str Username for test access to ActiveDirectory service (string)
- tls bool
Enable TLS connection (bool)
- type str
(Computed) The type of the resource (string)
- user_
disabled_ intbit_ mask User disabled bit mask. Default
2
(int)- user_
enabled_ strattribute User enable attribute (string)
- user_
login_ strattribute User login attribute. Default
sAMAccountName
(string)- user_
name_ strattribute User name attribute. Default
name
(string)- user_
object_ strclass User object class. Default
person
(string)- user_
search_ strattribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user_
search_ strbase User search base DN (string)
- user_
search_ strfilter User search filter (string)
- access
Mode String Access mode for auth.
required
,restricted
,unrestricted
are supported. Defaultunrestricted
(string)- allowed
Principal List<String>Ids Allowed principal ids for auth. Required if
access_mode
isrequired
orrestricted
. Ex:activedirectory_user://<DN>
activedirectory_group://<DN>
. The local admin (local://<admin id>
) and thetest_username
must be added too. (list)- annotations Map<Any>
Annotations of the resource (map)
- certificate String
CA certificate for TLS if selfsigned (string)
- connection
Timeout Number ActiveDirectory connection timeout. Default
5000
(int)- default
Login StringDomain ActiveDirectory defult login domain (string)
- enabled Boolean
Enable auth config provider. Default
true
(bool)- group
Dn StringAttribute Group DN attribute. Default
distinguishedName
(string)- group
Member StringMapping Attribute Group member mapping attribute. Default
member
(string)- group
Member StringUser Attribute Group member user attribute. Default
distinguishedName
(string)- group
Name StringAttribute Group name attribute. Default
name
(string)- group
Object StringClass Group object class. Default
group
(string)- group
Search StringAttribute Group search attribute. Default
sAMAccountName
(string)- group
Search StringBase Group search base (string)
- group
Search StringFilter Group search filter (string)
- labels Map<Any>
Labels of the resource (map)
- name String
(Computed) The name of the resource (string)
- nested
Group BooleanMembership Enabled Nested group membership enable. Default
false
(bool)- port Number
ActiveDirectory port. Default
389
(int)- servers List<String>
ActiveDirectory servers list (list)
- service
Account StringPassword Service account password for access ActiveDirectory service (string)
- service
Account StringUsername Service account DN for access ActiveDirectory service (string)
- start
Tls Boolean Enable start TLS connection (bool)
- test
Password String Password for test access to ActiveDirectory service (string)
- test
Username String Username for test access to ActiveDirectory service (string)
- tls Boolean
Enable TLS connection (bool)
- type String
(Computed) The type of the resource (string)
- user
Disabled NumberBit Mask User disabled bit mask. Default
2
(int)- user
Enabled StringAttribute User enable attribute (string)
- user
Login StringAttribute User login attribute. Default
sAMAccountName
(string)- user
Name StringAttribute User name attribute. Default
name
(string)- user
Object StringClass User object class. Default
person
(string)- user
Search StringAttribute User search attribute. Default
sAMAccountName|sn|givenName
(string)- user
Search StringBase User search base DN (string)
- user
Search StringFilter User search filter (string)
Package Details
- Repository
- Rancher2 pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
rancher2
Terraform Provider.