set ad-server

Description

Configures an existing Active Directory server object.

Syntax

set ad-server <domain> [ ipv4-address <ipv4-address> ] [ ipv6-address <ipv6-address> ] [ username <username> [password <password> [ user-dn <user-dn> [use-branch-path { true [branch-path <branch-path> ] | false } ]

When you fill the branch-path field, you can add multiple branches by chaining them into a single string with a semi-colon separator between them: branch1path;branch2path;branch3path

Parameters

Parameter

Description

branch-path

The branch of the domain to be used

Type: An LDAP DN

domain

Domain name

Type: Host name

ipv4-address

Domain controller IP address

ipv6-address

Domain controller IPv6 address

password

The user's password

A string that contains alphanumeric and special characters.

use-branch-path

Select only if you want to use only part of the user database defined in the Active Directory

Type: Boolean (true/false)

user-dn

FQDN of the user

Type: An LDAP DN

username

A user name with administrator privileges to communicate with the AD server

A string that contains up to 64 characters without spaces, of this set:

  • a-z (lower-case letters)

  • A-Z (upper-case letters)

  • 0-9 (digits)

  • '.' (period)

  • '-' (minus)

  • '@' (at)

Example

set ad-server myHost.com ipv4-address 192.168.1.1 ipv6-address ipv6addr username admin password a(&7Ba user-dn cn=John\ Doe,dc=example,dc=com use-branch-path true branch-path cn=John\ Doe,dc=example,dc=com