Compute Systems Manager REST API リファレンスガイド

7.4 認証情報を編集する

instanceIDに指定した認証情報を編集します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Credentials/＜instanceID＞

instanceID:

Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。

Credential

{
        "credentialName":"...",
        "description":"...",
        "forceChange":"...",
        "wmiCredential":{
            "emptyPassword":"...",
            "userID":"...",
            "userPassword":"...",
            "domainName":"...",
            "discoverHyperV":"...",
            "portNo":...
        },
        "sshCredential":{
            "userID":"...",
            "userPassword":"...",
            "suPassword":"...",
            "portNo":...
        },
        "vmwareCredential":{
            "userID":"...",
            "userPassword":"..."
        },
        "svpCredential":{
            "defaultAuthorization":"...",
            "userID":"...",
            "password":"...",
            "defaultPort":"...",
            "portNo":...
        }
}

属性	データ型	数	説明
credentialName	string	0～1	認証情報名（1～32バイト）。
description	string	0～1	認証情報の説明（0～500バイト）。
forceChange	string	0～1	対象の認証情報が管理対象リソースと関連を持つ場合に，強制的に編集するかどうか。 Disable：認証情報が管理対象リソースと関連づいている場合は編集しません。（デフォルト） Enable：認証情報が管理対象リソースと関連づていていも強制的に編集します。
wmiCredential	WmiCredential	0～1	Windowsホストへの接続に使用する認証情報。protocolTypeが'WMI'の場合に必要。それ以外の場合は無効。
sshCredential	SshCredential	0～1	Linuxホストへの接続に使用する認証情報。protocolTypeが'SSH'の場合に必要。それ以外の場合は無効。
vmwareCredential	VmWareCredential	0～1	VMWare ESXiへの接続に使用する認証情報。protocolTypeが'VMWARE'の場合に必要。それ以外の場合は無効。
svpCredential	SvpCredential	0～1	ブレードサーバまたはラックマウントサーバへの接続に使用する認証情報。protocolTypeが'SVP'の場合に必要。それ以外の場合は無効。

wmiCredential

属性	データ型	数	説明
emptyPassword	string	1	パスワードを指定するかどうか。 Disable：パスワードを指定します。 Enable：パスワードを指定しません。
userID	string	1	探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword	string	0～1	パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。emptyPasswordが'Disable'の場合に必要です。
domainName	string	0～1	ドメイン名（1～255バイト）。
discoverHyperV	string	0～1	Hyper-Vを探索対象にするかどうか。 Disable：Hyper-Vを探索対象にしません。（デフォルト） Enable：Hyper-Vを探索対象にします。
portNo	integer	0～1	ポート番号（1～65535）。Compute Systems ManagerがLinux版の場合に有効。そうでなければ無効。 デフォルトの値は5985です。

sshCredential

属性	データ型	数	説明
userID	string	1	探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword	string	1	パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。
suPassword	string	0～1	rootユーザーのパスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。
portNo	integer	1	SSHプロトコルで使用するポート番号（0～65535）。

vmwareCredential

属性	データ型	数	説明
userID	string	1	探索するリソースにアクセスするためのユーザーID（1～32バイト）。
userPassword	string	1	パスワードの文字列をbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。

svpCredential

属性	データ型	数	説明
defaultAuthorization	string	1	接続に，デフォルトのユーザーIDとパスワードを使用するかどうか。 Disable：指定したユーザーIDとパスワードを使用します。 Enable：デフォルトのユーザーIDとパスワードを使用します。
userID	string	0～1	探索するリソースにアクセスするためのユーザーID（1～32バイト）。defultAuthorizationが'Disable'の場合に必要。
password	string	0～1	パスワードをbase64でエンコードした文字列（エンコードする前の文字列は1～256バイト）。defultAuthorizationが'Disable'の場合に必要。
defaultPort	string	1	接続にデフォルトポートを使用するかどうか。 Disable：指定したポートを使用します。 Enable：デフォルトポートを使用します。
portNo	integer	0～1	ポート番号（0～35535）。defultPortが'Disable'の場合に示します。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

ApiResult

{
        "id":...
}

属性	データ型	数	説明
id	integer	1	編集した認証情報のinstanceIDが返ります。

リターンコード

HTTPステータスコード	結果コード	詳細コード	説明
200	0	0	正常終了。
400	2010	1	credentialNameに無効な値を指定しました。
400	2010	2	descriptionに無効な値を指定しました。
400	2010	3	指定された認証情報は，対象の認証情報と違います。
400	2010	4	指定した認証情報と同時に指定が必要な属性が指定されていません。
400	2010	10	defultAuthorizationに無効な値を指定しました。
400	2010	11	protocolTypeに'SVP'，defaultAuthorizationに'Disable'を指定する場合は，userIDも指定する必要があります。
400	2010	12	userIDに無効な値を指定しました。
400	2010	13	protocolTypeに'SVP'，defaultAuthorizationに'Disable'を指定する場合は，passwordも指定する必要があります。
400	2010	14	passwordに無効な値を指定しました。
400	2010	15	emptyPasswordに無効な値を指定しました。
400	2010	16	protocolTypeに'WMI'，emptyPasswordに'Disable'を指定する場合は，userPasswordも指定する必要があります。
400	2010	17	userPasswordに無効な値を指定しました。
400	2010	18	defaultPortに無効な値を指定しました。
400	2010	19	protocolTypeに'SVP'，defaultPortに'Disable'を指定する場合は，portNoも指定する必要があります。
400	2010	20	portNoに無効な値を指定しました。
400	2010	21	domainNameに無効な値を指定しました。
400	2010	22	discoverHyperVに無効な値を指定しました。
400	2010	23	suPasswordに無効な値を指定しました。
400	2010	24	forceChangeに無効な値を指定しました。
400	2010	100	リクエストボディーが指定されていません。
400	2010	101	リクエストボディーの書式が無効です。JSONの書式で記述してください。
401	1000	1	HTTPヘッダーのAuthorizationが指定されていません。
401	1000	2	HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401	1000	3	HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401	1000	4	ログインに失敗しました。
401	1002	1	ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403	1003	1	基本ライセンスが登録されていない，または有効期限を過ぎています。
403	1003	2	論理分割の機能を使用するためのプラグインライセンスがありません。または，ライセンスが無効です。日本語バージョンの場合，vmwareCredentialを編集するかdiscoverHyperVを'Enable'にして再実行してください。
403	2017	1	管理対象を参照する権限がありません。
404	-	-	指定したinstanceIDまたはcollectionはありません。
405	-	-	サポートされていないメソッドです。
406	2010	1	HTTPヘッダーのAcceptの値が不正です。
412	2013	1	指定したcredentialNameはCompute Systems Managerですでに使用済みです。
412	2150	20	指定された認証情報は幾つかのタスクで使用されているため，編集できません。
412	2150	21	指定された認証情報は幾つかの管理対象に関連づけられていますが，forceChangeに'Enable'が指定されていないため，編集できません。
415	-	-	HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500	-	-	HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500	1000	1	ログインに失敗しました（内部エラー）。
503	2020	1	要求の数がAPIの同時最大接続数を超えました。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.