Uninstall-SCXAgent
指定した管理対象 UNIX および Linux コンピューター上の管理エージェントをアンインストールします。
構文
Uninstall-SCXAgent
-Agent <IPersistedUnixComputer[]>
[-SshCredential <CredentialSet>]
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Uninstall-SCXAgent コマンドレットは、指定された UNIX および Linux コンピューター上の管理エージェントをアンインストールします。
必要な エージェント パラメーターは、アンインストールする対象の管理対象 UNIX または Linux コンピューターを指定し、UNIX または Linux コンピューター オブジェクトを必要とします。 マネージド UNIX または Linux コンピューターの取得については、Get-SCXAgent コマンドレットを参照してください。 オプションの SSHCredential パラメーターを指定して、管理エージェントのアンインストールに使用される特権資格情報を識別できます。 SSHCredential が指定されていない場合、コマンドレットはエージェントに対して定義された特権実行アカウントの使用を試みます。
このコマンドレットによる戻り値はありません。
例
例 1: 管理エージェントをアンインストールする
PS C:\>$Agent01 = Get-SCXAgent -Name "nx1.contoso.com"
PS C:\> $SSHCredential = Get-SCXSSHCredential -UserName "DavidChew" -Key "C:\keys\key21.ppk" -ElevationType sudo
PS C:\> Uninstall-SCXAgent -SSHCredential $SSHCredential -Agent $Agent01
最初のコマンドは、Get-SCXAgent コマンドレットを使用して、nx1.contoso.com という名前のマネージド Linux または UNIX コンピューターのエージェントを取得します。 このコマンドは、$Agent 01 変数に格納します。
2 番目のコマンドは、Get-SCXSSHCredential コマンドレットを使用して、ユーザーの特権資格情報を作成します。 このコマンドは、結果を$SSHCredential変数に格納します。
最後のコマンドでは、指定した SSH 資格情報を使用して、$Agent 01 の管理エージェントをアンインストールします。
例 2: 定義された実行アカウントを使用して管理エージェントをアンインストールする
PS C:\>Get-SCXAgent -Name "nx1.contoso.com" | Uninstall-SCXAgent
このコマンドは、 Get-SCXAgent を使用して、nx1.contoso.com という名前のマネージド Linux または UNIX コンピューターのエージェントを取得します。 このコマンドは、マネージド コンピューターを現在のコマンドレットに渡します。 このコマンドは、定義された実行アカウントを使用して管理エージェントをアンインストールします。
パラメーター
-Agent
1 つ以上の管理対象 UNIX または Linux コンピューター オブジェクトを指定します。
マネージド UNIX または Linux コンピューター オブジェクトを取得する方法については、「.」と入力します Get-Help Get-SCXAgent
。
Type: | IPersistedUnixComputer[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ComputerName
コンピューターの名前の配列を指定します。 コマンドレットは、これらのコンピューターの管理グループとの一時的な接続を確立します。 NetBIOS 名、IP アドレス、または完全修飾ドメイン名 (FQDN) を使用できます。 ローカル コンピューターを指定するには、コンピューター名、localhost、またはドット (.) を入力します。
System Center Data Access サービスは、コンピューター上でアクティブである必要があります。 コンピューターを指定しない場合、コマンドレットは現在の管理グループ接続にコンピューターを使用します。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
管理グループ接続を実行するユーザー アカウントを指定します。
このパラメーターに対して、Get-Credential コマンドレットから返される PSCredential オブジェクト ( Get-Credential コマンドレットが返すオブジェクトなど) を指定します。
資格情報オブジェクトの詳細については、「.」と入力します Get-Help Get-Credential
。
ComputerName パラメーターでコンピューターを指定する場合は、そのコンピューターにアクセスできるアカウントを使用します。 既定値は現在のユーザーです。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SCSession
Connection オブジェクトの配列を指定します。 接続オブジェクトを取得するには、Get-SCOMManagementGroupConnection コマンドレットを使用します。
このパラメーターが指定されていない場合、コマンドレットは管理グループへのアクティブな永続的な接続を使用します。
SCSession パラメーターを使用して、別の永続接続を指定します。
ComputerName パラメーターと資格情報パラメーターを使用して、管理グループへの一時的な接続を作成できます。
詳細を表示するには「Get-Help about_OpsMgr_Connections
」を入力します。
Type: | Connection[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SshCredential
エージェントメンテナンスアクションの実行に使用される特権 SSH 資格情報を指定します。 このパラメーターが指定されていない場合、コマンドレットは、エージェントの定義済みのエージェント メンテナンス実行アカウントの使用を試みます。
SSH 資格情報オブジェクトを取得する方法については、「.」と入力します Get-Help Get-SCXSSHCredential
。
Type: | CredentialSet |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
出力
このコマンドレットは、コンピューターのアンインストール状態を表す結果を返します。 結果には、次の情報が含まれます。
- ホスト名
- アンインストールの状態
- [説明]
説明には、アンインストールが失敗した理由の詳細が含まれています。