Cisco Finesse インストレーション/アップグレード ガイド Release 10.0(1)
Cisco Finesse CLI
Cisco Finesse CLI

Cisco Finesse CLI

CLI には、オペレーティング システムと Cisco Finesse に適用されるコマンドのセットがあります。 これらのコマンドでは、基本的なメンテナンスと障害復旧が可能になり、システム管理の一部を実行できます。

Finesse で使用できるのは一部の Cisco Unified Communications Manager CLI のため、Finesse で適用できないコマンドも多くあり、そのほとんどは Finesse では検証されていません。

直接、モニタとキーボードを使用してサーバ コンソールで、または SSH を介して CLI にアクセスできます。 インストール時に作成した管理者ユーザの資格情報を使用してサインインします。

Cisco Finesse でサポートされるコマンド

Finesse では次の CLI コマンドがサポートされており、使用できます。

ログの収集

これらのコマンドでは、ファイルのアップロード先としてセキュア FTP(SFTP)サーバの場所を指定するように求められます。

ログを取得するには、次のコマンドを実行します。

  • インストール ログ:file get install desktop-install.log システムのインストール後にこのコマンドを使用すると、インストール ログが表示されます。 このログは SFTP サーバに書き込まれ、テキスト ファイルとして次のパスに保存されます。<IP アドレス>\<日付とタイムスタンプ>\install\desktop-install.log
  • デスクトップ ログ:file get activelog desktop recurs compress Finesse Web アプリケーションのログを取得するには、このコマンドを使用します。 このコマンドを実行すると、次のディレクトリが含まれる zip ファイルがアップロードされます。
    • webservices:このディレクトリには、Finesse REST API を提供する Finesse バックエンドのログが含まれます。 圧縮されていないデスクトップ ログ ファイルの最大サイズは 100 MB です。 このディレクトリには最大 300 のログ ファイルが保存されます。 ログ ファイルが 100 MB に達すると、そのファイルは圧縮され、新しいログ ファイルが生成されます。 最後に圧縮されたデスクトップ ログ ファイルへの出力は、次に作成されるログ ファイルに引き継がれます。 ログ ファイルのラップアップ期間は、システムのユーザ数に基づいて異なります。 各デスクトップ ログ ファイル名にはタイム スタンプが含まれます。
    • desktop:このディレクトリには、Finesse デスクトップ ガジェットを保持する [Finesse Desktop Agent] ガジェットのコンテナからのログが保存されます。 Finesse Agent Desktop でのあらゆるコンテナ レベルのエラーがこれらのログ ファイルに表示されます。
    • admin:このディレクトリには、管理ガジェットを保持する [Finesse Administration] ガジェットのコンテナからのログが保存されます。 Finesse Administration Console でのあらゆるコンテナ レベルのエラーがこれらのログ ファイルに表示されます。
    • clientlogs:このディレクトリには、Finesse Agent Desktop から Finesse サーバに送信されたクライアント側のログが保存されます。 各ログ ファイルは 1.5 MB 未満で、ファイルを送信したエージェントのタイムスタンプとエージェント ID が含まれます。 エージェントがクライアント側のログを送信するたびに新しいログ ファイルが作成されます(既存のログ ファイルにはデータが追加されません)。 このディレクトリの最大サイズは 100 MB です。 ディレクトリが 100 MB に達すると、サイズが 100 MB を超えないように、最も古いファイルが削除されます。
    • openfireservice:このディレクトリには Cisco Finesse Notification Service の起動とシャットダウンに関連する情報のログが保存されます。
    • openfire:このディレクトリには Cisco Finesse Notification Service の限定されたエラーおよび情報のログが保存されます。
    これらのログは SFTP サーバの次のパスに保存されます:<IP アドレス>\<日付とタイムスタンプ>\active_nnn.tgz。ここで、nnn は長い形式のタイムスタンプです。
  • Servm ログ:file get activelog platform/log/servm*.* compress Finesse サービスの開始と停止を管理するプラットフォーム サービス マネージャによって生成されたログを取得するには、このコマンドを使用します。 デスクトップ ログと servm ログは 1 組のファイルに圧縮されます。 これらのログは SFTP サーバの次のパスに保存されます:<IP アドレス>\<日付とタイムスタンプ>\active_nnn.tgz。ここで、nnn は長い形式のタイムスタンプです。
  • プラットフォーム Tomcat ログ:file get activelog tomcat/logs recurs compress これらのログは SFTP サーバの次のパスに保存されます:<IP アドレス>\<日付とタイムスタンプ>\active_nnn.tgz。ここで、nnn は長い形式のタイムスタンプです。
  • VOS インストール ログ:file get install install.log これらのログは SFTP サーバの次のパスに保存されます:<IP アドレス>\<日付とタイムスタンプ>\active_nnn.tgz。ここで、nnn は長い形式のタイムスタンプです。

(注)  


ログ収集は、多数のログ ファイルがある場合に圧縮フラグを使用すると、失敗することがあります。 収集が失敗した場合、圧縮フラグなしでコマンドを再実行してください。


Cisco Finesse HTTPS リダイレクト

Cisco Finesse HTTPS リダイレクトを有効にすると、Finesse デスクトップおよび管理コンソールにアクセスするために HTTPS が適用されます。 Cisco Finesse HTTPS リダイレクトが有効な場合、HTTP を介してデスクトップにアクセスしようとするエージェントやスーパーバイザが HTTPS にリダイレクトされます。 HTTP を介して管理コンソールにアクセスしようとする管理者も、HTTPS にリダイレクトされます。


(注)  


デフォルトでは、Cisco Finesse HTTPS リダイレクトが有効です。


Cisco Finesse HTTPS リダイレクトが無効の場合、デスクトップおよび管理コンソールには HTTP または HTTPS を介してアクセスできます。


(注)  


このコマンドは、Finesse REST API には影響しません。


Cisco Finesse HTTPS リダイレクトのステータスが有効か無効かを表示するには、以下のコマンドを実行します。

  • Cisco Finesse HTTPS リダイレクトのステータスを取得するには:utils finesse application_https_redirect status このコマンドは、Cisco Finesse HTTPS リダイレクトが現在、システム上で有効か無効かを表示します。
  • Cisco Finesse HTTPS リダイレクトを有効にするには:utils finesse application_https_redirect enable Cisco Finesse HTTPS リダイレクトを有効にする前に、Cisco Tomcat サービスを停止する必要があります。 このサービスを停止するには、次のコマンドを使用します。utils service stop Cisco Tomcat。 Cisco Tomcat サービスが停止していない場合、Cisco Finesse HTTPS リダイレクトを有効にするコマンドは失敗します。 また、このコマンドは、Cisco Finesse HTTPS リダイレクトがすでに有効の場合にも失敗します。 Cisco Finesse HTTPS リダイレクトを有効にした後、コマンド utils service start Cisco Tomcat を使用して Cisco Tomcat サービスを開始します。
  • Cisco Finesse HTTPS リダイレクトを無効にするには:utils finesse application_https_redirect disable Cisco Finesse HTTPS リダイレクトを無効にする前に、Cisco Tomcat サービスを停止する必要があります。 このサービスを停止するには、次のコマンドを使用します。utils service stop Cisco Tomcat。 Cisco Tomcat サービスが停止していない場合、Cisco Finesse HTTPS リダイレクトを無効にするコマンドは失敗します。 また、このコマンドは、Cisco Finesse HTTPS リダイレクトがすでに無効の場合にも失敗します。 Cisco Finesse HTTPS リダイレクトを無効にした後、コマンド utils service start Cisco Tomcat を使用して Cisco Tomcat サービスを開始します。

Finesse サービス

サービスを表示、開始、停止するには:

  • Cisco Finesse で使用されるプラットフォームの TCP/IP サービス、UDP サービスおよび UNIX ドメイン ソケットを表示するには、show network all detail を使用します。
  • サービスのステータスを取得するには、utils service list を使用します。 すべてのサービスとそのステータスの一覧を取得します。 サービスの状態として、「STOPPED」、「STARTING」、「STARTED」のいずれかが表示されます。 「STOPPED」はサービスが動作していないことを意味します。 「STARTING」はサービスが動作を開始し、必要な初期化を実行していることを意味します。 「STARTED」はサービスが正常に初期化され、動作していることを意味します。
  • サービスを開始するには、utils service start サービス名を使用します。 このコマンドは、指定されたサービスを開始します。
  • サービスを停止するには、utils service stop サービス名を使用します。 このコマンドは、指定されたサービスを停止します。
  • Cisco Tomcat を起動するには、utils service start Cisco Tomcat を使用します。
  • Cisco Tomcat を停止するには、utils service stop Cisco Tomcat を使用します。
  • Cisco Tomcat を再起動するには、utils service restart Cisco Tomcat を使用します。

    (注)  


    Cisco Finesse サービス関連の問題がある場合、最後の手段として Finesse サービスの再起動を推奨します。 ほとんどのサービス関連の問題は、サービスを再起動しても修正できません。 Cisco DB を再起動することは推奨しません。


Cisco Finesse Notification Service のロギング

Cisco Finesse Notification Service のロギングのステータスが有効か無効かを表示するには、以下のコマンドを実行します。

  • Cisco Finesse Notification Service のロギングのステータスを取得するには:utils finesse notification logging status このコマンドは、Cisco Finesse Notification Service のロギングが現在、システム上で有効か無効かを表示します。

    (注)  


    Cisco Finesse Notification Service ロギングのステータスを取得するコマンドを実行する前に Cisco Finesse Notification Service を実行していることを確認します。 このサービスが実行されていない場合、このコマンドは失敗します。


  • Cisco Finesse Notification Service のロギングを有効にするには、次のコマンドを実行します。utils finesse notification logging enable

    (注)  


    Cisco Finesse Notification Service ロギングを有効にするコマンドを実行する前に Cisco Finesse Notification Service を実行していることを確認します。 このサービスが実行されていない場合、このコマンドは失敗します。 また、このコマンドは、Cisco Finesse Notification Service がすでに有効の場合にも失敗します。

    ロギングを有効にし、Cisco Finesse Notification Service を再起動すると、ロギングは自動的に無効になります。


  • Cisco Finesse Notification Service のロギングを無効にするには、次のコマンドを実行します。utils finesse notification logging disable

    (注)  


    Cisco Finesse Notification Service ロギングを無効にするコマンドを実行する前に Cisco Finesse Notification Service を実行していることを確認します。 このサービスが実行されていない場合、このコマンドは失敗します。 また、このコマンドは、Cisco Finesse Notification Service がすでに無効の場合にも失敗します。


アップグレード

アップグレード関連のコマンドは、utils system upgrade の下にグループ化されています。

アップグレードを開始するには、utils system upgrade initate を使用します。

このコマンドを使用すると、アップグレードおよび Cisco Option Package(COP)ファイルを、ローカルとリモートの両方のディレクトリからインストールできます。

アップグレードをキャンセルするには、utils system upgrade cancel を使用します。

リモート アカウント管理

リモート アクセス アカウントの有効化、無効化、作成、および状態の確認を行うには、次のコマンドを実行します。utils remote_account

リモート アカウントは、パス フレーズを生成します。シスコのサポート担当者はこれを使用することにより、アカウントの指定有効期間の間、システムにアクセスできます。

  • utils remote_account create account life account はアカウント名です。 life は、アカウントの有効期限を日単位で示します。
  • utils remote_account disable
  • utils remote_account enable
  • utils remote_account status

複製ステータス

複製ステータスを調べるには、プライマリ Finesse サーバで次のコマンドを実行してください。

  • utils dbreplication runtimestate このコマンドは、プライマリおよびセカンダリ Finesse サーバの両方で複製ステータスを返します。
  • 複製の RTMT カウンタ値を確認します。 クラスタのすべてのノードが複製ステータスとして 2 を示す場合、複製は正しく動作しています。
    図 1. 複製ステータス

  • クラスタ内のすべてのノードで複製ステータスの RTMT カウンタ値が 3 または 4 の場合、複製は設定されていますが、エラーが生じ、複製が正しく動作していません。
  • ノードの大半で値 0 または 1 が表示される場合は、プライマリ Finesse サーバから utils dbreplication reset all コマンドを実行します。
  • いずれかのノードに対して 1 または 2 以外の複製値が表示される場合、複製が正しく設定されていません。
  • 複製を修正するには、シスコ テクニカル サポートに問い合わせてください。

3rdpartygadget アカウント

3rdpartygadget アカウントはサードパーティ ガジェットを Finesse サーバにアップロードするために使用されます。 このアカウントを使用する前に、パスワードを設定する必要があります。

このパスワードは、アップグレード時に移行されません。 アップグレードの実行後、すべてのサードパーティ製ガジェットに対して変更を加えるようにするには、パスワードをリセットする必要があります。


(注)  


Finesse サーバにサードパーティ ガジェットをアップロードするには、開発者のサポート サービス契約が必要です。または、開発者サポート サービス契約を結んでいるシスコ パートナーと連携してください。 サードパーティ ガジェットをアップロードする方法の詳細については、『Cisco Finesse Web サービス デベロッパ ガイド』を参照してください。


3rdpartygadget アカウントのパスワードを設定(またはリセット)するには、CLI にアクセスし、次のコマンドを実行します。

utils reset_3rdpartygadget_password

パスワードを入力するプロンプトが表示されます。 パスワードを入力すると、パスワードを確認するように促されます。

3rdpartygadget アカウントのパスワードは 5 ~ 32 文字にする必要があり、スペースまたは引用符(")を含めることはできません。


(注)  


サードパーティ ガジェットはアップグレード時に移行され、DRS バックアップおよびリストアに含まれます。