EnableLdapAuthentication の略
EnableLdapAuthentication メソッドを使用すると、クラスタへの LDAP 認証で使用する LDAP ディレクトリ接続を設定できます。LDAP ディレクトリのメンバーであるユーザは、 LDAP クレデンシャルを使用してストレージシステムにログインできるようになります。
パラメータ
このメソッドの入力パラメータは次のとおりです。
名前 | 説明 | を入力します | デフォルト値 | 必須 |
---|---|---|---|---|
authType |
使用するユーザ認証方式を指定します。有効な値は次のとおり
|
文字列 |
SearchAndBind の場合 |
いいえ |
groupSearchBaseDN |
グループサブツリー検索を開始するツリーのベース DN 。 |
文字列 |
なし |
いいえ |
GroupSearchType |
使用されるデフォルトのグループ検索フィルタを制御します。有効な値は次のとおり
|
文字列 |
ActiveDirectory |
いいえ |
serverURI |
LDAP または LDAPS サーバの URI をカンマで区切ったリスト。カスタムポートは、コロンとポート番号を組み合わせて、 LDAP または LDAPS URI の末尾に追加できます。たとえば、「 ldap : //1.2.3.4 」という URI はデフォルトのポートを使用し、「 ldaps : //1.2.3.4 : 123 」という URI はカスタムポート 123 を使用します。 |
文字列の配列 |
なし |
はい。 |
userSearchBaseDN のことです |
サブツリー検索を開始するツリーのベース DN 。このパラメータは、 authType が SearchAndBind の場合に必要です。 |
文字列 |
なし |
いいえ |
searchBindDN |
ユーザの LDAP 検索を実行するためにログインで使用する完全修飾 DN 。LDAP ディレクトリへの読み取りアクセスが必要です。このパラメータは、 authType が SearchAndBind の場合に必要です。 |
文字列 |
なし |
はい。 |
searchBindPassword |
検索に使用する searchBindDN アカウントのパスワード。このパラメータは、 authType が SearchAndBind の場合に必要です。 |
文字列 |
なし |
はい。 |
userSearchFilter のように入力します |
LDAP サーバの照会に使用する LDAP 検索フィルタ。文字列にはプレースホルダテキスト「 %USERNAME% 」が必要です。この値は、認証ユーザのユーザ名で置換されます。たとえば、( & ( objectClass=person )( sAMAccountName=%USERNAME% ))は、 Active Directory の sAMAccountName フィールドを使用して、クラスタログイン時に入力されたユーザ名を照合します。このパラメータは、 authType が SearchAndBind の場合に必要です。 |
文字列 |
なし |
はい。 |
userDNTemplate |
ユーザの完全な識別名( DN )を作成するパターンの定義に使用する文字列テンプレート。文字列にはプレースホルダテキスト「 %USERNAME% 」が必要です。この値は、認証ユーザのユーザ名で置換されます。このパラメータは、 authType が DirectBind の場合に必要です。 |
文字列 |
なし |
はい。 |
groupSearchCustomFilter のように指定します |
CustomFilter 検索タイプを指定した場合に、ユーザのグループの DNS を返すための 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": { } }
新規導入バージョン
9.6