search

zstackio / doc-ch

ZStack Chinese user manual
Apache License 2.0
12 stars 21 forks source link

[LDAP]APIAddLdapServerMsg #90

Open xuexuemiao opened 7 years ago

xuexuemiao commented 7 years ago

描述

添加LdapServer配置，或用于测试连接。

API

org.zstack.ldap.APIAddLdapServerMsg

举例(Example)

管理员可以使用AddLdapServer来添加一个LdapServer连接. 例如: 

AddLdapServer name="ldap server 1" description="ldap server 1 description" url="ldap://localhost:1888" base="dc=example,dc=com,dc=cn" username="uid=username,ou=people,dc=example,dc=com,dc=cn" password="password" encryption="None"

返回结果：

{
    "inventory": [
        {
            "base": "dc=example,dc=com,dc=cn",
            "createDate": "Sep 8, 2016 10:28:34 AM",
            "description": "ldap server 1 description",
            "encryption": "None",
            "lastOpDate": "Sep 8, 2016 10:28:34 AM",
            "name": "ldap server 1",
            "password": "password",
            "url": "ldap://localhost:1888",
            "username": "uid=username,ou=people,dc=example,dc=com,dc=cn",
            "uuid": "ebc8055882374ff19f46c3234163b36e"
        }
    ],
    "success": true
}

管理员可以使用AddLdapServer，以及一个systemTag，来测试一个LdapServer连接. 例如: 

AddLdapServer name="ldap server 1" description="ldap server 1 description" url="ldap://localhost:1888" base="dc=example,dc=com,dc=cn" username="uid=username,ou=people,dc=example,dc=com,dc=cn" password="password" encryption="None" systemTags="ephemeral::validationOnly"

返回结果：

{
    "inventory": [
        {
            "base": "dc=example,dc=com,dc=cn",
            "createDate": "Sep 8, 2016 10:28:34 AM",
            "description": "ldap server 1 description",
            "encryption": "None",
            "lastOpDate": "Sep 8, 2016 10:28:34 AM",
            "name": "ldap server 1",
            "password": "password",
            "url": "ldap://localhost:1888",
            "username": "uid=username,ou=people,dc=example,dc=com,dc=cn",
            "uuid": "ebc8055882374ff19f46c3234163b36e"
        }
    ],
    "success": true
}

参数（Parameters）

名字 描述 可选的参数 起始支持版本
name LdapServer连接的一个用于识别的名字
description LdapServer连接的一个简短的描述
username 连接该LdapServer的用户DN
password 密码
url LdapServer的连接地址
base 用于查询的LdapServer起始DN
encryption 加密方式：None或者TLS。需要注意url要与该参数对应

备注

  1. 目前仅支持一个LdapServer连接配置

Feature_link