Patch

/activedirectory/{id}/

This endpoint joins or leaves an Active Directory domain.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

ID of the Active Directory configuration for the Active Directory server to join

Body parameters

object

admin_username

string Required

An Active Directory admin user with permission to join the Active Directory server.

admin_passwd

string Required

The password for the specified Active Directory admin user.

enabled

boolean Required

Set to true to join Active Directory. Set to false to leave Active Directory.

smb_allowed

boolean

Indicates if the Active Directory configuration is allowed to serve as a provider for SMB attributes.

Defaultfalse

url

string

LDAP server URI in the format ://

.

can be either a DNS name or an IP address. Example: ldap://ldap.company.com

urls

Array of string

Comma separated list of URIs of LDAP servers in the format ://

. The order of listing defines the priority order. The URI with highest priority that has a good health status is used.

string

port

integer

The port of the remote LDAP server. Typical values: 389, 636.

binddn

string

The bind DN for authenticating to the LDAP domain. You can specify any user account that has read access to the domain.

bindpw

string

The password used with the Bind DN to authenticate to the LDAP server.

searchbase

string

The entry in the LDAP directory tree to use as a starting point for user queries.

group_searchbase

string

Base DN for group queries within the joined domain only. When auto discovery is enabled, group queries outside the joined domain use auto-discovered Base DNs.

netgroup_searchbase

string

Base DN for netgroup queries.

ExampleOU=netgroups,OU=system,DC=umiacs,DC=umd,DC=edu

method

string

The authentication method configured on the LDAP server for authenticating clients.

Valid values[ "ANONYMOUS", "SIMPLE", "SASL", "KRBV4", "KRBV41", "KRBV42" ]

gid_number

string

Override 'gidNumber' as the attribute of a group entry that contains the group's GID number. When binding VAST Cluster to AD, you may need to set this to 'gidnumber' (case sensitive).

uid

string

Override 'uid' as the attribute of a user entry on the LDAP server that contains the user name. When binding VAST Cluster to AD, you may need to set this to 'sAMAccountname'.

uid_number

string

Override 'uidNumber' as the attribute of a user entry on the LDAP server that contains the UID number. Often when binding VAST Cluster to Active Directory this does not need to be set.

match_user

string

The attribute to use when querying a provider for a user that matches a user that was already retrieved from another provider. A user entry that contains a matching value in this attribute will be considered the same user as the user previously retrieved.

abac_read_only_value_name

string

The attribute to use when querying a provider for a read only attribute access check

abac_read_write_value_name

string

The attribute to use when querying a provider for a read-write attribute access check

uid_member

string

Override 'memberUid' as the attribute of a group entry on the LDAP server that contains names of group members. When binding VAST Cluster to AD, you may need to set this to 'memberUID'

posix_account

string

Override 'posixAccount'as the object class that defines a user entry on the LDAP server. When binding VAST Cluster to AD, set this parameter to 'user' in order for authorization to work properly.

posix_group

string

Override 'posixGroup' as the object class that defines a group entry on the LDAP server. When binding VAST Cluster to AD, set this parameter to 'group' in order for authorization to work properly.

tls_certificate

string

TLS certificate to use for verifying the remote LDAP server's TLS certificate.

use_tls

boolean

Set to true to enable use of TLS to secure communication between VAST Cluster and the LDAP server.

reverse_lookup

boolean

resolve netgroups into hostnames

use_posix

boolean

POSIX support

query_groups_mode

string

A mode setting for how groups are queried: Set to COMPATIBLE to look up user groups using the 'memberOf' and 'memberUid' attributes. Set to RFC2307BIS_ONLY to look up user groups using only the 'memberOf' attribute. Set to RFC2307_ONLY to look up user groups using only the 'memberUid' attribute. Set to NONE not to look up user groups other than by leading GID and primary group SID.

username_property_name

string

The attribute to use for querying users in VMS user-initated user queries. Default is 'name'. Sometimes set to 'cn'

domain_name

string

FQDN of Active Directory domain. Must be resolvable in DNS

user_login_name

string

The attribute used to query Active Directory for the user login name in NFS ID mapping. Applicable only with Active Directory and NFSv4.

group_login_name

string

The attribute used to query Active Directory for the group login name in NFS ID mapping. Applicable only with Active Directory and NFSv4.

mail_property_name

string

uid_member_value_property_name

string

use_auto_discovery

boolean

When enabled, Active Directory Domain Controllers (DCs) and Active Directory domains are auto discovered. Queries extend beyond the joined domain to all domains in the forest. When disabled, queries are restricted to the joined domain and DCs must be provided in the URLs field.

use_ldaps

boolean

Use LDAPS for Auto-Discovery

is_vms_auth_provider

boolean

Enables use of the LDAP for VMS authentication. Two LDAP configurations per cluster can be used for VMS authentication: one with Active Directory and one without.

posix_attributes_source

string

Defines which domains POSIX attributes will be supported from.

Valid values[ "JOINED_DOMAIN", "ALL_DOMAINS", "SPECIFIC_DOMAINS", "GC" ]

domains_with_posix_attributes

string

Allows to enumerate specific domains for POSIX attributes in case posix_attributes_source is set to SPECIFIC_DOMAINS.

use_multi_forest

boolean

Allow access for users from trusted domains on other forests.

ntlm_enabled

boolean

Enable/disable support of NTLM authentication method for SMB protocol.

scheduled_ma_pwd_change_enabled

boolean

Enables scheduled Machine Account password change.

ma_pwd_change_frequency

string

Machine Account password change frequency.

ma_pwd_update_time

string

Machine Account password update time.

super_admin_groups

Array of string

List of groups on the Active Directory provider. Members of these groups can log into VMS as cluster admin users.

string

monitor_action

string

The type of periodic health check that VAST Cluster performs for the Active Directory provider. PING (default, less overhead and impact on the provider) = pings the provider. BIND = binds to the provider.

Valid values[ "PING", "BIND" ]

is_abac_provider

boolean

True if the Active Directory is used for ABAC

Responses

200

Expand All

object

async_task

object

Creation Async task properties

Join or Leave Active Directory