EnableLdapAuthentication

EnableLdapAuthenticationメソッドを使用すると、クラスタへのLDAP認証で使用するLDAPディレクトリ接続を設定できます。LDAPディレクトリのメンバーであるユーザは、LDAPクレデンシャルを使用してストレージ システムにログインできるようになります。

パラメータ

このメソッドの入力パラメータは次のとおりです。

名前 説明 タイプ デフォルト値 必須
authType 使用するユーザ認証方法を指定します。有効な値は次のとおりです。
  • DirectBind
  • SearchAndBind
文字列 SearchAndBind ×
groupSearchBaseDN グループ サブツリー検索を開始するツリーのベースDN。 文字列 なし ×
groupSearchType 使用されているデフォルトのグループ検索フィルタ。有効な値は次のとおりです。
  • NoGroups:グループのサポートなし。
  • ActiveDirectory:あるユーザのActive Directoryグループをすべてネストしたメンバーシップ。
  • MemberDN:MemberDN形式のグループ(単一レベル)。
文字列 ActiveDirectory ×
serverURIs LDAPサーバのURIをカンマで区切ったリスト (例:「ldap://1.2.3.4」と「ldaps://1.2.3.4:123」)。 文字列の配列 なし
userSearchBaseDN サブツリー検索を開始するツリーのベースDN。このパラメータは、authTypeSearchAndBindを使用する場合に必要です。 文字列 なし ×
searchBindDN ユーザのLDAP検索を実行するためにログインで使用する完全修飾DN。LDAPディレクトリへの読み取りアクセスが必要です。このパラメータは、authTypeSearchAndBindを使用する場合に必要です。 文字列 なし
searchBindPassword 検索に使用するsearchBindDNアカウントのパスワード。このパラメータは、authTypeSearchAndBindを使用する場合に必要です。 文字列 なし
userSearchFilter LDAPサーバの照会に使用するLDAP検索フィルタ。文字列にはプレースホルダ テキスト「%USERNAME%」が必要です。この値は、認証ユーザのユーザ名で置換されます。たとえば、(&(objectClass=person)(sAMAccountName=%USERNAME%))は、Active DirectoryのsAMAccountNameフィールドを使用して、クラスタ ログイン時に入力されたユーザ名を照合します。このパラメータは、authTypeSearchAndBindを使用する場合に必要です。 文字列 なし
userDNTemplate ユーザの完全な識別名(DN)を作成するパターンの定義に使用する文字列テンプレート。文字列にはプレースホルダ テキスト「%USERNAME%」が必要です。この値は、認証ユーザのユーザ名で置換されます。このパラメータは、authTypeDirectBindを使用する場合に必要です。 文字列 なし
groupSearchCustomFilter CustomFilter検索タイプを指定した場合に、ユーザのグループのDNを返すためのLDAPフィルタ。文字列には必要に応じてプレースホルダ テキスト「%USERNAME%」および「%USERDN%」を含めることができます。これらの値は、ユーザ名および完全なuserDNで置換されます。 文字列 なし

戻り値

このメソッドには戻り値はありません。

要求例

このメソッドの要求例を次に示します。

{
  "method": "EnableLdapAuthentication",
  "params": {
     "authType": "SearchAndBind",
     "groupSearchBaseDN": "dc=prodtest,dc=solidfire,dc=net",
     "groupSearchType": "ActiveDirectory",
     "searchBindDN": "SFReadOnly@prodtest.solidfire.net",
     "searchBindPassword": "zsw@#edcASD12",
     "sslCert": "",
     "userSearchBaseDN": "dc=prodtest,dc=solidfire,dc=net",
     "userSearchFilter": "(&(objectClass=person)(sAMAccountName=%USERNAME%))",
     "serverURIs":[
           "ldaps://111.22.333.444",
           "ldap://555.66.777.888"
           ]
       },
  "id": 1
}

応答例

このメソッドの応答例を次に示します。

{
"id": 1,
"result": {
  }
}