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":...
       }
}

属性データ型説明
credentialNamestring0~1認証情報名(1~32バイト)。
descriptionstring0~1認証情報の説明(0~500バイト)。
forceChangestring0~1対象の認証情報が管理対象リソースと関連を持つ場合に,強制的に編集するかどうか。
  • Disable:認証情報が管理対象リソースと関連づいている場合は編集しません。(デフォルト)
  • Enable:認証情報が管理対象リソースと関連づていていも強制的に編集します。
wmiCredentialWmiCredential0~1Windowsホストへの接続に使用する認証情報。protocolTypeが'WMI'の場合に必要。それ以外の場合は無効。
sshCredentialSshCredential0~1Linuxホストへの接続に使用する認証情報。protocolTypeが'SSH'の場合に必要。それ以外の場合は無効。
vmwareCredentialVmWareCredential0~1VMWare ESXiへの接続に使用する認証情報。protocolTypeが'VMWARE'の場合に必要。それ以外の場合は無効。
svpCredentialSvpCredential0~1ブレードサーバまたはラックマウントサーバへの接続に使用する認証情報。protocolTypeが'SVP'の場合に必要。それ以外の場合は無効。

wmiCredential

属性データ型説明
emptyPasswordstring1パスワードを指定するかどうか。
  • Disable:パスワードを指定します。
  • Enable:パスワードを指定しません。
userIDstring1探索するリソースにアクセスするためのユーザーID(1~32バイト)。
userPasswordstring0~1パスワードの文字列をbase64でエンコードした文字列(エンコードする前の文字列は1~256バイト)。emptyPasswordが'Disable'の場合に必要です。
domainNamestring0~1ドメイン名(1~255バイト)。
discoverHyperVstring0~1Hyper-Vを探索対象にするかどうか。
  • Disable:Hyper-Vを探索対象にしません。(デフォルト)
  • Enable:Hyper-Vを探索対象にします。
portNointeger0~1ポート番号(1~65535)。Compute Systems ManagerがLinux版の場合に有効。そうでなければ無効。
デフォルトの値は5985です。

sshCredential

属性データ型説明
userIDstring1探索するリソースにアクセスするためのユーザーID(1~32バイト)。
userPasswordstring1パスワードの文字列をbase64でエンコードした文字列(エンコードする前の文字列は1~256バイト)。
suPasswordstring0~1rootユーザーのパスワードの文字列をbase64でエンコードした文字列(エンコードする前の文字列は1~256バイト)。
portNointeger1SSHプロトコルで使用するポート番号(0~65535)。

vmwareCredential

属性データ型説明
userIDstring1探索するリソースにアクセスするためのユーザーID(1~32バイト)。
userPasswordstring1パスワードの文字列をbase64でエンコードした文字列(エンコードする前の文字列は1~256バイト)。

svpCredential

属性データ型説明
defaultAuthorizationstring1接続に,デフォルトのユーザーIDとパスワードを使用するかどうか。
  • Disable:指定したユーザーIDとパスワードを使用します。
  • Enable:デフォルトのユーザーIDとパスワードを使用します。
userIDstring0~1探索するリソースにアクセスするためのユーザーID(1~32バイト)。defultAuthorizationが'Disable'の場合に必要。
passwordstring0~1パスワードをbase64でエンコードした文字列(エンコードする前の文字列は1~256バイト)。defultAuthorizationが'Disable'の場合に必要。
defaultPortstring1接続にデフォルトポートを使用するかどうか。
  • Disable:指定したポートを使用します。
  • Enable:デフォルトポートを使用します。
portNointeger0~1ポート番号(0~35535)。defultPortが'Disable'の場合に示します。

レスポンスボディー

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

ApiResult

{
       "id":...
}

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

リターンコード

HTTPステータスコード結果コード詳細コード説明
20000正常終了。
40020101credentialNameに無効な値を指定しました。
40020102descriptionに無効な値を指定しました。
40020103指定された認証情報は,対象の認証情報と違います。
40020104指定した認証情報と同時に指定が必要な属性が指定されていません。
400201010defultAuthorizationに無効な値を指定しました。
400201011protocolTypeに'SVP',defaultAuthorizationに'Disable'を指定する場合は,userIDも指定する必要があります。
400201012userIDに無効な値を指定しました。
400201013protocolTypeに'SVP',defaultAuthorizationに'Disable'を指定する場合は,passwordも指定する必要があります。
400201014passwordに無効な値を指定しました。
400201015emptyPasswordに無効な値を指定しました。
400201016protocolTypeに'WMI',emptyPasswordに'Disable'を指定する場合は,userPasswordも指定する必要があります。
400201017userPasswordに無効な値を指定しました。
400201018defaultPortに無効な値を指定しました。
400201019protocolTypeに'SVP',defaultPortに'Disable'を指定する場合は,portNoも指定する必要があります。
400201020portNoに無効な値を指定しました。
400201021domainNameに無効な値を指定しました。
400201022discoverHyperVに無効な値を指定しました。
400201023suPasswordに無効な値を指定しました。
400201024forceChangeに無効な値を指定しました。
4002010100リクエストボディーが指定されていません。
4002010101リクエストボディーの書式が無効です。JSONの書式で記述してください。
40110001HTTPヘッダーのAuthorizationが指定されていません。
40110002HTTPヘッダーのAuthorizationの値が不正です(Basic認証,HSSOセッション認証のどちらでもありません)。
40110003HTTPヘッダーのAuthorizationのBasic認証の値が不正です(認証情報のフォーマットが不正です)。
40110004ログインに失敗しました。
40110021ログインセッションが切断されました。または,不正なHSSOトークンが指定されました。
40310031基本ライセンスが登録されていない,または有効期限を過ぎています。
40310032論理分割の機能を使用するためのプラグインライセンスがありません。または,ライセンスが無効です。日本語バージョンの場合,vmwareCredentialを編集するかdiscoverHyperVを'Enable'にして再実行してください。
40320171管理対象を参照する権限がありません。
404--指定したinstanceIDまたはcollectionはありません。
405--サポートされていないメソッドです。
40620101HTTPヘッダーのAcceptの値が不正です。
41220131指定したcredentialNameはCompute Systems Managerですでに使用済みです。
412215020指定された認証情報は幾つかのタスクで使用されているため,編集できません。
412215021指定された認証情報は幾つかの管理対象に関連づけられていますが,forceChangeに'Enable'が指定されていないため,編集できません。
415--HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500--HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。
50010001ログインに失敗しました(内部エラー)。
50320201要求の数がAPIの同時最大接続数を超えました。