4.13.16 OSユーザーの削除
機能
WindowsまたはUNIX環境でOSユーザーを削除します。
この部品では,次のサーバを前提とします。
・実行対象サーバ
この部品を実行する対象となるサーバです。前提条件に記載のWindowsまたはUNIXがセットアップされている必要があります。
Windowsの場合,ローカルユーザーまたはドメインユーザーを削除できます。
削除するユーザー種別に応じてプロパティWindows.userTypeに次の値を設定します。
・ローカルユーザーを削除する場合:local
・ドメインユーザーを削除する場合:domain
UNIXの場合,削除するOSユーザーのホームディレクトリもあわせて削除することができます。
プロパティUNIX.homeDirectoryDeleteに次の値を設定します。
・OSユーザーのホームディレクトリを削除する場合:yes
・OSユーザーのホームディレクトリを削除しない場合:no
実行対象サーバのOSがWindowsの場合,この部品の実行にはAdministratorユーザ(ビルトインAdministratorアカウント)が必要です。実行対象サーバにAdministratorユーザ(ビルトインAdministratorアカウント)が存在しない場合,または,無効の場合,システムアカウントで実行を行う部品「OSユーザーの削除(SYSTEM)」を実行してください。
利用場面
運用に使用するOSユーザーを削除する場合などに利用できます。
前提条件
【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については,リリースノートを参照してください。
また、OSおよび製品について略称を用いています。対象とするOSおよび製品については「はじめに」を参照してください。
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server
(2) Red Hat Enterprise Linux Server
(3) Oracle Linux
【実行対象サーバの使用条件】
なし。
注意事項
(1)実行対象サーバがUNIXの場合,ユーザーのホームディレクトリを削除する場合は,必要に応じてホームディレクトリに格納されたデータを退避してください。
(2) UNIX環境に対してこの部品を実行する場合は,プロパティにマルチバイト文字を使用しないでください。
バージョン
04.00.00
部品のタグ
Configure OS,Windows,Linux
タスクログに表示される部品の名称
osDeleteUser
戻り値
戻り値 |
説明 |
---|---|
0 |
正常 |
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
27 |
異常(エラー内容はタスクログで確認) |
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
---|---|---|---|---|---|
common.osUserName |
OSユーザー名 |
削除するOSユーザーのユーザー名を指定します。 |
− |
入力 |
○ |
Windows.userType |
OSユーザー種別 |
OSユーザーの種別をローカル(local)またはドメイン(domain)で指定します。domainの場合,操作対象サーバのドメインのプライマリドメインコントローラに対して操作を行います。このプロパティはWindowsだけで有効です。 |
local |
入力 |
△ |
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
Linux.homeDirectoryDelete |
ホームディレクトリの削除可否 |
OSユーザー削除後にユーザーのホームディレクトリを削除するかどうかをyes(削除する)またはno(削除しない)で指定します。このプロパティはエージェントサーバのOSがUNIXの場合のみ有効です。 |
no |
入力 |
△ |
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |