Upload
lyhanh
View
218
Download
0
Embed Size (px)
Citation preview
VN-M004-024
Visual Nexus Ver4.0 コマンドリファレンス
2009/10/30 第4版
沖電気工業株式会社
はじめに
2
VN-M004-024
お問い合わせ 製品の一般的な情報
Visual Nexus製品サポート情報: http:// www.visualnexus.com/jp/support.htm ※製品に関する技術的サポートの提供方法などについては、ご購入の代理店にお問い合わせください。
Visual Nexus Ver4.0 コマンドリファレンス 2008/10/31 第1版 2009/3/31 第2版 2009/7/31 第3版 2009/10/30 第4版
発行日: 2009年10月30日 発行元: 沖電気工業株式会社 OKIビジネスセンタ 〒108-8551 東京都港区芝浦4丁目10番16号
はじめに
3
VN-M004-024
ごあいさつ この度は、「Visual Nexus」を導入していただき、誠にありがとうございます。 Visual Nexus は、離れた拠点間を高品質の映像と音声でリアルタイムに結び、ビジネスコミュニケーションのスピード向上とコスト削減を実現するシステムです。 本書は、Visual Nexus Telnet Interfaceのコマンドリファレンスです。Visual Nexusの設定・運用時に、Visual Nexus Telnet Interfaceでコマンド操作を行う場合にお読みください。
なお、製品に関する技術的サポートの提供方法などについては、ご購入の代理店にお問い合わせください。ま
た、製品の一般的な情報については、下記 URLをご覧ください。
Visual Nexus製品サポート情報:http://www.visualnexus.com/jp/support.html
本書について
本書の位置づけ
Visual Nexusリリースノート
(システム管理者向け)
Visual Nexusのインストール CDの構成や、改善点、制限事項、
既知の問題について記載しています。(本書)
↓ Visual Nexus Secure Transport 概要/
製品紹介
Visual Nexus Secure Transportの製品概要について記載していま
す。
↓ Visual Nexus管理者ガイド
(システム管理者向け)
Visual Nexusの概要、サーバのインストール方法、システム設
定、管理設定、注意点などについて記載しています。
↓ Visual Nexusコマンドリファレンス
(システム管理者向け)
Visual Nexus Telnet Interfaceで使用可能なコマンドについて記載
しています。
↓ Visual Nexusユーザセットアップガイ
ド(一般ユーザ向け)
Visual Nexusクライアントのインストール方法、セットアップ方
法などについて記載しています。
Visual Nexus ユーザ操作ガイド
(一般ユーザ向け)
Visual Nexus クライアントの基本的な操作方法、注意点などにつ
いて記載しています。
Visual Nexus コマンドリファレンス
(システム管理者向け)
Visual Nexus Telnet Interfaceで使用可能なコマンドについて記載しています。(本書)
本書で使用している表記 メニュー、アイコン、
ボタン、タブの操作
[ ]で囲んで表記します。
(例)[キャンセル]ボタンをクリックします。
はじめに
4
VN-M004-024
キーボード上のキーの操作 < >で囲んで表記します。
(例)<Alt>キーを押します。
ディレクトリ、メニューの
選択
[メインメニュー名]-[サブメニュー名]
(例)[プログラム]-[Internet Explorer]を選択します。
参照先 別冊は『 』、参照箇所は「 」で囲んで表記します。
(例)「本書について」を参照してください。
表示画面などについて 表示画面などは、操作の一例として掲載しているため、ご使用の端末に表示される画面とは異なる場合もあり
ます。
商標について Visual Nexus、Visual Nexusロゴは、沖電気工業株式会社の登録商標です。 Linuxは、Linus Torvaldsの商標です。 その他、本書に記載されている会社名、製品名は、それぞれ各社の商標または登録商標です。
版権/注意 本書の内容の一部または全部を無断で複写転載することを禁じます。 本書に掲載の内容および製品の仕様などは、予告なく変更されることがあります。 本書の内容は万全を期して作成しておりますが、万一ご不明な点や誤り、記載もれ、乱丁、落丁などお気づきの点がございましたら、弊社までご連絡ください。
Copyright 2003-2009 Oki Electric Industry Co., Ltd. All rights reserved.
目次
5
VN-M004-024
目次
ごあいさつ ...................................................................................................................................................................... 3 本書について .................................................................................................................................................................. 3
本書の位置づけ........................................................................................................................ 3
本書で使用している表記.......................................................................................................... 3
表示画面などについて ............................................................................................................. 4
商標について ........................................................................................................................... 4
版権/注意............................................................................................................................... 4 目次................................................................................................................................................................................. 5
Telnet Interfaceの操作 ...................................................................................................................................................... 6 1.1. Telnet Interfaceのログイン ..................................................................................................................................... 6 1.2. Telnet Interfaceの基本書式 ..................................................................................................................................... 6 1.3. Telnet Interfaceのログオフ ..................................................................................................................................... 7
Telnet Interfaceコマンド .................................................................................................................................................. 8 2.1. Telnetseコマンド制御............................................................................................................................................. 8 2.2. ライセンスコマンド................................................................................................................................................ 9 2.3. ゲートキーパコマンド .......................................................................................................................................... 10 2.4. ミーティング設定コマンド ................................................................................................................................... 17 2.5. ミーティング運営コマンド ................................................................................................................................... 27 2.6. ユーザ/グループリストコマンド ........................................................................................................................ 30 2.7. サーバ設定コマンド.............................................................................................................................................. 38 2.8. 組織設定コマンド ................................................................................................................................................. 43
6
VN-M004-024
11 TTeellnneett IInntteerrffaacceeのの操操作作
1.1. Telnet Interfaceのログイン Visual Nexus Telnet Interface(以下、Telnet Interface)コマンドを使用するためには、Visual Nexus Meeting Serverがインストールされている Linuxサーバで Telnet Interfaceにログインする必要があります。
1 Linuxサーバにログインします。 Linuxサーバのアカウントでログインします。特に管理者権限を有するアカウントの必要はありません。
2 Telnet Interfaceにアクセスします。
# telnet 127.0.0.1 8000
Telnet Interfaceの「login:」プロンプトが表示されます。
3 Visual Nexusで管理者権限のあるユーザ名を入力し、<Enter>キーを押します。 初めてログインする場合は、「Administrator」(デフォルト)を入力します。
login: Administrator
「password:」プロンプトが表示されます。
4 ユーザのパスワードを入力し、<Enter>キーを押します。 初めてログインする場合は、「visualnexus」(デフォルト)を入力します。
password:
Telnet Interfaceにログインします。 「API@VisualNexus=#」プロンプトが表示され、Telnet Interface コマンドを入力できる状態になります。
Login success. API@VisualNexus=#
1.2. Telnet Interfaceの基本書式 Telnet Interfaceコマンドの基本書式は、
[コマンド] [オペレーション] [引数…] です。オペレーションには、list / detailes / change /create / deleteなどがあります。 オペレーションを指定しない場合は、コマンドの簡単な書式が表示されます。
1.3. Telnet Interfaceのログオフ
7
VN-M004-024
各コマンドの使用方法については、「2. Telnet Interfaceコマンド」を参照してください。 なお、本書では、各書式で引数などを以下のように表現しています。
表記 説明
< > ユーザが引数を指定します(< >は入力しません)。 <" ">の場合は、文字列を指定します(<" ">は入力しません)。
[ ] ユーザが任意の数だけ指定できることを示します。 | | | | |のいずれかを選択します。 ( ) 指定を省略可能です。
日本語を指定する場合、ターミナルの文字セットを指定する必要があります。ターミナルがシフト JIS の場合、以下のコマンドを入力し、<Enter>キーを押します。
API@VisualNexus=# ENCODING SJIS
1.3. Telnet Interfaceのログオフ Telnet Interface は、「API@VisualNexus=#」プロンプトで「exit」を入力して<Enter>キーを押すと、ログオフできます。
API@VisualNexus=# exit
8
VN-M004-024
22 TTeellnneett IInntteerrffaacceeココママンンドド
2.1. Telnetseコマンド制御 ここでは、Telnetseコマンド制御について記載します。
ENCODING
説明: ターミナルの文字セットを指定します。 日本語のミーティング名などを使用するときに指定します。
書式: ENCODING <"encoding-name">
"encoding-name":エンコーディング名
・SJIS シフト JIS文字セット ・EUC_JP EUC日本語文字セット ・UTF8 UTF8文字セット
TIME_ZONE
説明: Telnet Interfaceコマンドで時間の指定表示を行う場合に使用するタイムゾーンを指定します。
書式: TIME_ZONE <"timezone-name">
"timezone-name":タイムゾーン名
・JST 日本時間(デフォルト)
exit 説明:
Telnet Interfaceを終了します。 書式:
exit
2.2. ライセンスコマンド
9
VN-M004-024
2.2. ライセンスコマンド ここでは、ライセンスコマンドについて記載します。
license
説明: ライセンスの情報取得/インストール/アンインストールを行います。
書式: license list
Meeting Server(License Server)にインストールされているライセンス情報を取得します。
license create <"license number"> 指定したライセンス番号を Meeting Server(License Server)にインストールします。 その際にインストールキーを取得します。
license delete <"license number"> 指定したライセンス番号を Meeting Server(License Server)から削除します。
"license number":Visual Nexusのライセンス番号
lsactivate
説明: ライセンスをアクティベートします。
書式: lsactivate <"activate key"> アクティベーションキーに対応するライセンスをアクティベートします。
"activate key":アクティベーションキー
lstoken
説明: ライセンストークン情報を取得/削除します。
書式: lstoken list <"requestmode">
requestmodeに対応するライセンストークン情報を取得します。
lstoken delete <"requestmode"> requestmodeに対応するライセンストークン情報を削除します。
"requestmode":どの種類のトークンを対象にするかを指定
・preassign プリアサインしたものを対象 ・dynamic 上記以外を対象 ・all すべてを対象
2.3. ゲートキーパコマンド
10
VN-M004-024
lsassign 説明:
ライセンスのプリアサイン、プリアサインされたライセンスの解放を行います。 書式:
lsassign assign <productcode> <numberoflicense> <nodename> ライセンスをプリアサインします。
lsassign free <productcode> <nodename> プリアサインされたライセンスを解放します。
productcode:製品コード numberoflicense:プリアサインするライセンスの数 nodename:プリアサインの対象となる相手
たとえば、Server Licenseをプリアサインする場合は、ミーティングの H.323エリアスを指定 Endpoint Licenseをプリアサインする場合は、VNEPの H.323エリアスを指定
lsstatus
説明: ライセンスの状態を確認します。
書式: lsstatus
2.3. ゲートキーパコマンド ここでは、ゲートキーパコマンドについて記載します。
gkactivate
説明: ゲートキーパ・サービスの状態を制御します。
書式: gkactivate <"bool"> ゲートキーパをアクティブ、インアクティブにします。
"bool":"true"または"false"を指定
gatekeeper
説明: ゲートキーパの基本情報を取得します。
書式: gatekeeper list ゲートキーパの基本情報を取得します。
<取得する基本情報> Status(ゲートキーパ動作中を示す) Zonename(Zone名) Call Signal IP Address(ゲートキーパの Call Signal IP Address) RAS IP Address(ゲートキーパの RAS IP Address) Gatekeeper Identifer(ゲートキーパ IDとして使用される名前) Alt RAS IP Address(自分で解決できない名前の解決を依頼するゲートキーパ) Forwardmode(ゲートキーパの動作モード)
2.3. ゲートキーパコマンド
11
VN-M004-024
gkepinfo 説明:
ゲートキーパに登録されている Endpointの情報を取得/削除します。 書式:
gkepinfo list <"type"> <"data"> [<"type"> <"data"> [ .. ] ] ゲートキーパに登録されている Endpointの情報を取得します。
<Endpointの情報を Call Signal IP Addressで検索する場合> "type":"call"を指定 "data":Call Signal IP Addressとポートを指定
xxx.xxx.xxx.xxx:xxxx形式
<Endpointの情報を RAS IPで検索する場合> "type":"ras"を指定 "data":RAS IPとポートを指定
xxx.xxx.xxx.xxx:xxxx形式
<Endpointの情報を ALIASで検索する場合> "type":"h323"または”e164”を指定 "data":H.323エリアスまたは E.164番号を指定
<Endpointの情報を Endpoint IDで検索する場合> "type":"epid"を指定 "data":ゲートキーパで管理している Endpointの IDを指定
gkepinfo change <type> <data> [<type> <data> [...]]
call,ras,h323,e164,epidで指定されたゲートキーパに登録されている Endpointの情報を変更します。 <TreminalTypeを変更する場合> "type":”terminal”を指定 "data":terminal_class(0:EP、1:MCU、2:GW、3:Other)を指定 <TimeToLiveを変更する場合> "type":”ttl”を指定 "data":数値を指定 <WillRespondToIRRを変更する場合> "type":”rirr”を指定 "data":数値を指定 <AlmostOutOfResourcesを変更する場合> "type":”almost”を指定 "data":almost_out_of_resource(0:false、1:true)を指定
gkepinfo delete <"type"> <"data"> [<"type"> <"data"> [ .. ] ] (<drq> <bool>) ゲートキーパに登録されている Endpointの情報を削除します。 指定する"type"と"data"は gkepinfo list書式と同様です。 呼確立中の Endpointを強制削除する場合は、drq trueを最後に指定します。
2.3. ゲートキーパコマンド
12
VN-M004-024
gkeplist 説明:
ゲートキーパに登録されている Endpointのリストを取得します。 書式:
gkeplist
gkconfinfo 説明:
ゲートキーパに登録されているミーティング情報を取得/削除します。 書式:
gkconfinfo list <"confname"> 指定したミーティング名から、ゲートキーパに登録されているミーティング情報を取得します。
gkconfinfo change <"confname"> <type> <data> [<type> <data> [...]] 指定したミーティング名から、ゲートキーパに登録されているミーティング情報を変更します。
変更できるタイプは以下のとおりです。
<TTLを変更する場合> "type":”ttl”を指定 "data":数値を指定
<lockを変更する場合> "type":”lock”を指定 "data":lock_status(0:free|1:lock)の 0か 1を指定
gkconfinfo delete <"confname"> 指定したミーティング名から、ゲートキーパに登録されているミーティング情報を削除します。
"confname":ミーティング名
2.3. ゲートキーパコマンド
13
VN-M004-024
gkconflist 説明:
ゲートキーパに登録されているミーティングの H.323エリアスのリストを取得します。 書式:
gkconflist
gkcallinfo 説明:
ゲートキーパに登録されている情報を取得/削除します。 書式:
gkcallinfo list <"type"> <"data"> [<"type"> <"data"> [ .. ] ] Endpointに対する呼情報を取得します。
<呼情報を CallSignalIPで検索する場合> "type":"call"を指定 "data":Call Signal IP Addressとポートを指定
xxx.xxx.xxx.xxx:xxxx形式
<呼情報を RAS IPで検索する場合> "type":"ras"を指定 "data":RAS IPとポートを指定
xxx.xxx.xxx.xxx:xxxx形式
<呼情報を ALIASで検索する場合> "type":”h323”または”e164”を指定 "data":H.323エリアスまたは E.164番号を指定
<呼情報を Endpoint IDで検索する場合> "type":"epid"を指定 "data":ゲートキーパで管理している Endpointの IDを指定
gkcallinfo delete <"type"> <"data"> [<"type"> <"data"> [ .. ] ] (<drq> <bool>) 呼情報を削除します。 指定する"type"と"data"は gkcallinfo list書式と同様です。 <呼情報削除時に EndPointへ DRQを送信する場合> "type":"drq"を指定 "data":drq_mode(true)を指定
restrictione164 説明:
ゲートキーパに登録できるエンドポイントを E.164番号で制限します。 書式:
restrictione164 list <restriction_id> 制限のリストを表示します。
restrictione164 create <type> <data> [<type> <data> [...]] 制限を追加します。
<制限 IDを登録する場合> "type":"rid"を指定
2.3. ゲートキーパコマンド
14
VN-M004-024
"data":登録する restriction_idを指定
<ルールを登録する場合> "type":"rule"を指定 "data":登録する制限の許可/不許可を指定
<番号長を登録する場合> "type":"length"を指定 "data":登録する制限の番号長を指定
<条件を登録する場合> "type":"condition"を指定 "data":登録する制限の番号長の条件(-1:LESS|0:EQUAL|1:GREATER)を指定
<プレフィックスを登録する場合> "type":"prefix"を指定 "data":登録する制限のプレフィックスを指定
<優先順位を登録する場合> "type":"metric"を指定 "data":登録する制限の優先順位を指定
restrictione164 change <type> <data> [<type> <data> [...]] 制限を変更します。 指定する"type"と"data"は restrictione164 create書式と同様です。
restrictione164 delete <restriction_id> 制限を削除します。 指定する restriction_idは restrictione164 create書式と同様です。
restrictionip 説明:
ゲートキーパに登録できるエンドポイントを IPアドレスで制限します。 書式:
restrictionip list <restriction_id> 制限のリストを表示します。
restrictionip create <type> <data> [<type> <data> [...]] 制限を追加します。
<制限 IDを登録する場合> "type":"rid"を指定 "data":登録する restriction_idを指定
<ルールを登録する場合> "type":"rule"を指定 "data":登録する制限の許可/不許可を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する制限の IPアドレスを指定
<ネットマスクを登録する場合> "type":"mask"を指定
2.3. ゲートキーパコマンド
15
VN-M004-024
"data":登録する制限のネットマスクを指定
<優先順位を登録する場合> "type":"metric"を指定 "data":登録する制限の優先順位を指定
restrictionip change <type> <data> [<type> <data> [...]] 制限を変更します。 指定する"type"と"data"は restrictionip create書式と同様です。
restrictionip delete <restriction_id> 制限を削除します。 指定する restriction_idは restrictionipcreate書式と同様です。
neighborgk
説明: 隣接ゲートキーパ(隣接 GK)のリストの取得/作成/変更/削除を行います。
書式: neighborgk list <neighborgk_id> 隣接 GKのリストを表示します。
neighborgk create <type> <data> [<type> <data> [...]] 隣接 GKを追加します。
<隣接 GKIDを登録する場合> "type":"nid"を指定 "data":登録する neighborgk_idを指定
<プレフィックスを登録する場合> "type":"prefix"を指定 "data":登録するプレフィックスを指定
<優先順位を登録する場合> "type":"metric"を指定 "data":登録する優先順位を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する IPアドレスとポート(ipaddress:port)を指定
<ゲートキーパ IDを登録する場合> "type":"gkid"を指定 "data":登録するゲートキーパ IDを指定
neighborgk change <type> <data> [<type> <data> [...]] 隣接 GKを変更します。 指定する"type"と"data"は neighborgk create書式と同様です。
neighborgk delete <neighborgk_id> 隣接 GKを削除します。
2.3. ゲートキーパコマンド
16
VN-M004-024
plugingk 説明:
名前解決(プラグイン)のリストの取得/作成/変更/削除を行います。 書式:
plugingk list <plugingk_id> 名前解決のリストを表示します。
plugingk create <type> <data> [<type> <data> [...]] 名前解決のプラグインを作成します。
<プラグイン IDを登録する場合> "type":"pid"を指定 "data":登録する plugingk_idを指定
<表締名を登録する場合> "type":"display"を指定 "data":登録するプラグインの表示名を指定
<ファイル名を登録する場合> "type":"file"を指定 "data":登録するプラグインのファイル名を指定
<優先順位を登録する場合> "type":"metric"を指定 "data":登録する優先順位を指定
<有効/無効を登録する場合> "type":"enable"を指定 "data":登録するプラグインの有効/無効を boolで指定
plugingk change <type> <data> [<type> <data> [...]] 名前解決のプラグインを変更します。 指定する"type"と"data"は plugingk create書式と同様です。
plugingk delete <plugingk_id> 名前解決のプラグインを削除します。
2.4. ミーティング設定コマンド
17
VN-M004-024
2.4. ミーティング設定コマンド ここでは、ミーティング設定コマンドについて記載します。
conf
説明: ミーティングの情報取得/作成/削除を行います。
書式: conf list (confid) ミーティング情報を取得します。
conf create <"type"> <"data"> [<"type"> <"data"> [ .. ] ] ミーティング情報を登録します。
<会議名を登録する場合> "type":"name"を指定 "data":登録する会議名を指定
<テンプレート IDを登録する場合> "type":"tmp"を指定 "data":登録するテンプレート IDを指定
<組織を登録する場合> "type":"org"を指定 "data":登録する組織を指定
conf delete <confid> 指定したミーティング IDに該当するミーティングを削除します。
confname
説明: ミーティング名のリスト取得/変更を行います。
書式: confname list (confid) ミーティング名のリストを取得します。
confname change <confid> <confname> 指定したミーティング IDに該当するミーティング名を変更します。
confid:ミーティング ID "confname":ミーティング名
nickname
説明: ミーティングの H.323エリアスのリスト取得/変更を行います。
書式: nickname list (confid) ミーティングの H.323エリアスのリストを取得します。
nickname change <confid> <"nickname"> 指定したミーティング IDに該当するミーティングの H.323エリアスを変更します。
confid:ミーティング ID "nickname":H.323エリアス
2.4. ミーティング設定コマンド
18
VN-M004-024
confnumber 説明:
ミーティングの E.164番号を取得/変更します。 書式:
confnumber list (confid) ミーティングの E.164番号を取得します。
confnumber change <confid> <e164number> 指定したミーティング IDに該当するミーティングの E.164番号を変更します。 データを削除するには e164numberに resetを指定します。
confid:ミーティング ID e164number:E.164番号
participants
説明: ミーティングの最大参加者数を取得/変更します。
書式: participants list (confid) ミーティングの最大参加者数を取得します。
participants change <confid> <participants> 指定したミーティング IDに該当するミーティングの最大参加者数を変更します。
confid:ミーティング ID participants:最大参加者数
confkind
説明: ミーティングのタイプを取得/変更します。
書式: confkind list (confid) ミーティングのタイプを取得します。
confkind change <confid> <kindid> 指定したミーティング IDに該当するミーティングのタイプを変更します。
confkind details 設定可能なミーティングのタイプ一覧を取得します。
confid:ミーティング ID kindid:ミーティングタイプ
2.4. ミーティング設定コマンド
19
VN-M004-024
bandwidth 説明:
ミーティングの最大帯域を取得/変更します。 書式:
bandwidth list (confid) ミーティングの最大帯域を取得します。
bandwidth change <confid> <bandwidth> 指定したミーティング IDに該当するミーティングの最大帯域を変更します。
confid:ミーティング ID bandwidth:最大帯域
bandwidthep
説明: ミーティングに接続する Endpointの最大帯域を取得/変更します。
書式: bandwidthep list (confid) ミーティング参加者の最大帯域を取得します。
bandwidthep change <confid> <bandwidth> 指定したミーティング IDに該当する Endpointの最大帯域を変更します。
confid:ミーティング ID bandwidth:最大帯域
bandwidthdynamic
説明: MCUの帯域制御方法を取得/変更します。
書式: bandwidthdynamic list (confid)
MCUの帯域制御方法を取得します。
bandwidthdynamic change <confid> <dynamicid> 指定したミーティング IDに該当する MCUの帯域制御方法を変更します。
bandwidthdynamic details 設定可能な MCUの帯域制御方法の一覧を取得します。
confid:ミーティング ID dynamicid:MCUの帯域制御方法
audio
説明: ミーティングのオーディオ使用可否の情報取得/変更を行います。
書式: audio list (confid) ミーティングのオーディオ使用可否の情報を取得します。
audio change <confid> <audiomode> 指定したミーティング IDに該当するミーティングのオーディオ使用可否を変更します。
confid:ミーティング ID audiomode:"true"または"false"を指定
2.4. ミーティング設定コマンド
20
VN-M004-024
audiocodec 説明:
ミーティングのオーディオコーデックを取得/変更します。 書式:
audiocodec list (confid) ミーティングのオーディオコーデックを取得します。
audiocodec change <confid> <audiocodecid> 指定したミーティング IDに該当するミーティングのオーディオコーデックを変更します。
audiocodec details 設定可能なオーディオコーデックの一覧を取得します。
confid:ミーティング ID audiocodecid:オーディオコーデック
audiolatency
説明: ミーティングのオーディオ遅延値を取得/変更します。
書式: audiolatency list (confid) ミーティングのオーディオ遅延値を取得します。
audiolatency change <confid> <frame> 指定したミーティング IDに該当するミーティングのオーディオ遅延値を変更します。
confid:ミーティング ID frame:オーディオ遅延値
video
説明: ミーティングのビデオ使用可否の情報取得/変更を行います。
書式: video list (confid) ミーティングのビデオ使用可否情報を取得します。
video change <confid> <videomode> 指定したミーティング IDに該当するミーティングのビデオ使用可否を変更します。
confid:ミーティング ID videomode:"true"または"false"を指定
2.4. ミーティング設定コマンド
21
VN-M004-024
videocodec 説明:
ミーティングのビデオコーデックを取得/変更します。 書式:
videocodec list (confid) ミーティングのビデオコーデックを取得します。
videocodec change <confid> <videocodecid> 指定したミーティング IDに該当するミーティングのビデオコーデックを変更します。
videocodec details 設定可能なビデオコーデックの一覧を取得します。
confid:ミーティング ID videocodecid:ビデオコーデック
resolution
説明: ミーティングのビデオ解像度を取得/変更します。
書式: resolution list (confid) ミーティングのビデオ解像度を取得します。
resolution change <confid> <resolutionid> 指定したミーティング IDに該当するミーティングのビデオ解像度を変更します。
resolution details 設定可能なビデオ解像度の一覧を取得します。
confid:ミーティング ID resolutionid:ビデオ解像度
vmode
説明: ミーティングのビデオ配信方法を取得/変更します。
書式: vmode list (confid) ミーティングのビデオ配信方法を取得します。
vmode change <confid> <vmode> 指定したミーティング IDに該当するミーティングのビデオ配信方法を変更します。
vmode details 設定可能なビデオ配信方法の一覧を取得します。
confid:ミーティング ID vmode:ビデオ配信方法
2.4. ミーティング設定コマンド
22
VN-M004-024
vsmode 説明:
ミーティングのビデオ切替方法を取得/変更します。 書式:
vsmode list (confid) ミーティングのビデオ切替方法を取得します。
vsmode change <confid> <vsmode> (time) 指定したミーティング IDに該当するミーティングのビデオ切替方法を変更します。
vsmode detals 設定可能なビデオ切替方法の一覧を取得します。
confid:ミーティング ID vsmode:ビデオ切替方法 time:時間
vfps 説明:
ミーティングのデコードフレームレートを取得/変更します。 書式:
vfps list (confid) ミーティングのデコードフレームレートを取得します。
vfps change <confid> <video fps> 指定したミーティング IDに該当するミーティングのフレームレートを変更します。
confid:ミーティング ID video fps:フレームレート(30、15、10のどれか)を指定。デフォルトは”15”
template 説明:
ミーティングのテンプレートモードを取得/変更します。 書式:
template list (confid) ミーティングのテンプレートモードを取得します。
template change <confid> <templatemode> 指定したミーティング IDに該当するテンプレートモードを変更します。
confid:ミーティング ID templatemode:"true"または"false"を指定
2.4. ミーティング設定コマンド
23
VN-M004-024
schedule 説明:
ミーティングのスケジュールモードのリスト取得/変更を行います。 書式:
schedule list (confid) ミーティングのスケジュールモードのリストを取得します。
schedule change <confid> <schedulemode> (scheduletime) (interval) (repeatmode) 指定したミーティング IDに該当するスケジュールモードを変更します。
schedule details 設定可能なスケジュールモードと繰返しモードの一覧を取得します。
confid:ミーティング ID schedulemode:スケジュールモード(1:常時開催、2:非開催、3:スケジュール開催) scheduletime:スケジュールの時間(開始時間:YYYY/MM/DD hh:mm) interval:会議開催時間(単位:分) repeatmode:繰返しモード (1:繰り返し無し、2:日毎に繰り返し、3:週毎に繰り返し、4:月毎に繰り返し) 例) schedule change 7 3 "2009/10/30 10:00" 60 1
ミーティング ID7のスケジュール開催を、2009年10月30日10時から60分の間だけ開催します。
access 説明:
ミーティングのアクセス制限のリスト取得/変更を行います。 書式:
access list (confid) ミーティングのアクセス制限のリストを取得します。
confid:ミーティング ID
access change <confid> <bool> <type> [<type>] 指定したミーティング IDに該当するミーティングのアクセス制限を変更します。
<アクセス制限を行う場合> bool:"true"を指定 type:ip(IPアドレス制御)、alias(H.323エリアス制御)、servercall(MCU発呼)を指定
<アクセス制限を行わない場合> bool:"false"を指定
confactivate
説明: ミーティングをアクティブ/インアクティブにする。
書式: confactivate <confid> <bool> 指定したミーティング IDに該当するミーティングをアクティブ/インアクティブにします。
confid:ミーティング ID bool:"true"または"false"を指定
2.4. ミーティング設定コマンド
24
VN-M004-024
epconf 説明:
ミーティングに割当てられているアクセスリストの取得/作成/削除を行います。 書式:
epconf list (confid) ミーティングのアクセスリストを取得します。
confid:ミーティング ID
epconf create <confid> <"type"> <adddata> 指定したミーティング IDに該当するミーティングのアクセスリストを作成します。
<アクセスリストにユーザを追加する場合) "type":"ep"を指定 adddata:ユーザ IDを指定
<アクセスリストにグループを追加する場合> "type":"gp"を指定 adddata:グループ IDを指定
epconf delete <confid> <"type"> (deletedata) 指定したミーティング IDに該当するミーティングのアクセスリストを削除します。
<アクセスリストに登録されているユーザを削除する場合> "type":"ep"を指定 deletedata:ユーザ IDを指定
<アクセスリストに登録されているグループを削除する場合> "type":"gp"を指定 deletedata:グループ IDを指定
<アクセスリストに登録されているデータをすべて削除する場合> "type":"all"を指定 deletedataの指定は不要
outlook
説明: ミーティングに割当てられている Outlook統合の取得/変更を行います。
書式: outlook list (confid) ミーティングの Outlook統合情報を取得します。
outlook change <confid> <bool> ミーティングの Outlook統合情報を変更します。
2.4. ミーティング設定コマンド
25
VN-M004-024
usemt 説明:
ミーティングの帯域変換モードを取得/変更します。 書式:
usemt list (confid) ミーティングの帯域変換モードを取得します。
usemt change <confid> <bool> 指定したミーティング IDに該当する帯域変換モードを変更します。
confid: ミーティング ID bool: "true"または"false"を指定
注意: 本機能を利用するには、VNMTオプション製品が必要です。
usevnc
説明: ミーティングでの VNC利用可否を取得/設定します。
書式: usevnc list (confid) ミーティングでの VNC利用可否を取得します。
usevnc change <confid> <bool> 指定したミーティングの VNC利用可否を変更します。
confid: ミーティング ID bool: "true"または"false"を指定
bandwidthvnc
説明: ミーティング参加者が VNCで使用する1端末あたりの最大送受信帯域を取得/変更します。
書式: bandwidthvnc list (confid) 1端末あたりの VNC最大送受信帯域を取得します。
bandwidthvnc change <confid> <bandwidth> 1端末あたりの VNC最大送受信帯域を変更します。
confid:ミーティング ID bandwidthvnc:最大帯域
h239mode
説明: ミーティングの h239モードを取得/変更します。
書式: h239mode list (confid) ミーティングの h239モードを取得します。
h239mode change <confid> <h239mode> 指定したミーティング IDに該当する h239モードを変更します。
confid:ミーティング ID h239mode:"true"または"false"を指定
2.4. ミーティング設定コマンド
26
VN-M004-024
confcpnmix
説明: ミーティングの CPNレイアウト数の取得/変更を行います。
書式: confcpnmix list (confid) ミーティングの CPNレイアウト数を取得します。
confcpnmix change <confid> <number_of_mix> 指定したミーティング IDに該当する CPNレイアウト数を変更します。
confid:ミーティング ID number_of_mix:CPNレイアウト数
confcpnpositoin
説明: ミーティングの CPNレイアウト1に固定されているユーザの取得/変更/削除を行います。
書式: confcpnpositoin list <confid> ミーティングの CPNレイアウト1に固定されているユーザを取得します。
confcpnpositoin create <confid> <endpointid> ミーティングの CPNレイアウト1に固定するユーザを変更します。
confid:ミーティング ID endpointid:ユーザ ID
confcpnpositoin delete <confid> ミーティングの CPNレイアウト1に固定されているユーザを削除します。
confid:ミーティング ID
confinvite
説明: ミーティングの自動呼出しモードの取得/変更を行います。
書式: confinvite list (confid) ミーティングの自動呼出しモードを取得します。
confinvite change <confid> <type> <data> [<type> <data> [...]] 指定したミーティング IDに該当する自動呼出しモードを変更します。
confid:ミーティング ID
<自動呼出しを行う場合> "type":"invite"を指定 "data":"true"を指定
<自動呼出し時間を行う場合> "type":"min"を指定 "data":呼出し時間(分)を指定
<自動呼出しを行わない場合> "type":"invite"を指定 "data":"false"を指定
2.5. ミーティング運営コマンド
27
VN-M004-024
audiofactor 説明:
ミーティングの手動音声ゲイン設定値の取得/設定を行います。 書式:
audiofactor list <confid> <endpointid> confid: 会議 ID endpointid: ユーザ ID
audiofactor change <confid> <endpointid> <factor:0-10000> confid: 会議 ID endpointid: ユーザ ID factor: 音声ゲインの倍率[%]. 有効な値は 0<=factor<=10000
confspb
説明: ミーティングの共有アドレス帳モードの取得/設定を行います。
書式: confspb list (confid) confid: 会議 ID
confspb change <confid> <spbid> confid: 会議 ID spbid: 共有アドレス帳モード 1:NONE 2:H323ALIAS
2.5. ミーティング運営コマンド ここでは、ミーティング運営コマンドについて記載します。
callep
説明: Endpointをミーティングに呼出します。
書式: callep <confid> <"id"|"h323"|”e164”|"ip"> <endpointid|"h323alias”|”e164alias"|"ipaddress"> 指定したミーティングに Endpointを呼出します。
confid:ミーティング ID "id":endpointの指定に idを使用 "h323":endpointの指定に H.323エリアスを使用 “e164”:endpointの指定に E.164番号を使用 "ip":endpointの指定に ipaddressを使用 endpointid:endpointidを指定(前項で"id"を指定した場合に有効) "h323alias":H.323エリアスを指定(前項で"h323"を指定した場合に有効) “e164alias”:E.164番号を指定(前項で”e164”を指定した場合に有効) "ipaddress":IPアドレスを指定(前項で"ip"を指定した場合に有効)
2.5. ミーティング運営コマンド
28
VN-M004-024
kill
説明: Endpointをミーティングから切断します。
書式: kill <confid> <"id"|"al"> <endpointid|"terminalalias"> 指定したミーティングから Endpointを切断します。
confid:ミーティング ID "id":endpointの指定に idを使用 "al":endpointの指定に H.323エリアスを使用 endpointid:endpointidを指定(前項で"id"を指定した場合に有効) "terminalalias":H.323エリアスを指定(前項で"al"を指定した場合に有効)
user 説明:
ミーティングに参加しているユーザリストを取得します。 書式:
user <confid> 指定したミーティングに参加しているユーザリストを取得します。
confid:ミーティング ID
placemode 説明:
Presentationミーティングの制御モードを取得/変更します。 書式:
placemode list <confid> 指定したミーティングの制御モードを取得します。
placemode change <confid> <placemodeid> 指定したミーティングの制御モードを変更します。
confid:ミーティング ID placemodeid:Presentationミーティングの制御モード 1:PresentationMode (プレゼンテーションモード) 2:CommunicationMode (秘話モード) 3:BroadcastMode (オープンモード)
videoswitch
説明: ユーザの映像チャネル情報の取得/設定を行います。
書式: videoswitch list <confid> <type1> <data1>
confid: 会議 ID <ユーザ IDでユーザを指定する場合> "type":"id"を指定 "data":チャネル情報を取得するユーザのユーザ IDを指定
2.5. ミーティング運営コマンド
29
VN-M004-024
<H.323 エリアスでユーザを指定する場合> "type1":"h323"を指定 "data1":チャネル情報を取得するユーザの H.323 エリアスを指定 <E.164 番号でユーザを指定する場合> "type1":"e164"を指定 "data1":チャネル情報を取得するユーザの E.164 番号を指定 <IP アドレスでユーザを指定する場合> "type1":"ip"を指定 "data1":チャネル情報を取得するユーザの IP アドレスを指定 videoswitch change <confid> <type1> <data1> <cell> <type2> <data2> confid: 会議 ID <ユーザ IDでユーザを指定する場合> "type1":"id"を指定 "data1":チャネル情報を設定するユーザのユーザ IDを指定 <H.323 エリアスでユーザを指定する場合> "type1":"h323"を指定 "data1":チャネル情報を設定するユーザの H.323 エリアスを指定 <E.164 番号でユーザを指定する場合> "type1":"e164"を指定 "data1":チャネル情報を設定するユーザの E.164 番号を指定 <IP アドレスでユーザを指定する場合> "type1":"ip"を指定 "data1":チャネル情報を設定するユーザの IP アドレスを指定 cell: チャネル番号 <ユーザ IDでチャネルに設定するユーザを指定する場合> "type2":"sid"を指定 "data2":チャネルに設定するユーザのユーザ IDを指定 <H.323 エリアスでチャネルに設定するユーザを指定する場合> "type2":"sh323"を指定 "data2":チャネルに設定するユーザの H.323 エリアスを指定 <E.164 番号でチャネルに設定するユーザを指定する場合> "type2":"se164"を指定 "data2":チャネルに設定するユーザの E.164 番号を指定 <IP アドレスでチャネルに設定するユーザを指定する場合> "type2":"sip"を指定 "data2":チャネルに設定するユーザの IP アドレスを指定
2.6. ユーザ/グループリストコマンド
30
VN-M004-024
2.6. ユーザ/グループリストコマンド ここでは、ユーザ/グループリストコマンドについて記載します。
group
説明: グループ情報を取得/登録/変更/削除します。
書式: group list (groupid) グループ情報のリストを取得します。
groupid:グループ ID
group create <"type"> <"data"> [<"type"> <"data"> [ .. ] ] グループ情報を登録します。
<グループ名を登録する場合> "type":"name"を指定 "data":登録するグループ名を指定
<組織を登録する場合> "type":"org"を指定 "data":登録する組織を指定
group change <groupid> <"type"> <"data"> [<"type"> <"data"> [ .. ] ] 指定したグループ IDに該当するグループ情報を変更します。 指定する"type"と"data"は group create書式と同様です。
group delete <groupid> 指定したグループ IDに該当するグループを削除します。
endpoint
説明: ユーザ情報を取得/登録/変更/削除します。
書式: endpoint list (endpointid) ユーザ情報のリストを取得します。
endpointid:ユーザ ID
endpoint create <"type"> <"data"> [<"type"> <"data"> [ .. ] ] ユーザ情報を登録します。
<ログイン名を登録する場合> "type":"name"を指定 "data":登録するログイン名を指定
<パスワードを登録する場合> "type":"pass"を指定 "data":登録するパスワードを指定
2.6. ユーザ/グループリストコマンド
31
VN-M004-024
<名前を登録する場合> "type":"fname"を指定 "data":登録する名前を指定
<ミドルネームを登録する場合> "type":"mname"を指定 "data":登録するミドルネームを指定 <姓を登録する場合> "type":"lname"を指定 "data":登録する姓を指定
<e-mailを登録する場合> "type":"mail"を指定 "data":登録する e-mailアドレスを指定
<H.323エリアスを登録する場合> "type":"h323"を指定 "data":登録する H.323エリアスを指定
<E.164番号を登録する場合> "type":"e164"を指定 "data":登録する E.164番号を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する IPアドレスを指定
<ユーザタイプを登録する場合> "type":"terminal"を指定 "data":terminal_type(1:VNEP|2:H323|3:GW|4:MCU|5:STUSER)を指定 <管理者権限を登録する場合> "type":"admin"を指定 "data":管理者権限を付与する場合は"true"、付与しない場合は"false"を指定(デフォルトは"true")
<STの使用方法を登録する場合> "type": "sttype"を指定 "data": st_use_type(1:AUTO_PC|2:AUTO_GC|3:PC|4:GC|5:DIRECT) <デフォルト STサーバを登録する場合> "type": "stsvr1"を指定 "data": デフォルト STサーバのサーバ id <代替 STサーバを登録する場合> "type": "stsvr2"を指定 "data": 代替 STサーバのサーバ id <STクライアントを登録する場合> "type": "stclient"を指定 "data": STクライアントのクライアント id
2.6. ユーザ/グループリストコマンド
32
VN-M004-024
<ユーザテンプレートを指定する場合> “type”: ”tmpid”を指定 “data”: ユーザテンプレート id <個人帯域を登録する場合> "type": "maxbw" "data": 帯域 <VNC帯域を登録する場合> "type": "vncbw" "data": VNC帯域 <組織を登録する場合> "type":"org"を指定 "data":登録する組織を指定
endpoint change <endpointid> <"type"> <"data"> [<"type"> <"data"> [ .. ] ] (reset) 指定したユーザ IDに該当するユーザ情報を変更します。 指定する"type"と"data"は endpoint create書式と同様です。 データを削除する場合は、resetを指定します。
endpoint delete <endpointid> 指定したユーザ IDに該当するユーザ情報を削除します。
2.6. ユーザ/グループリストコマンド
33
VN-M004-024
eproute 説明:
ユーザ情報とグループ情報を関連付けたリストの取得/作成/削除を行います。 書式:
eproute list (<"gp"> <groupid>) グループに所属するユーザのリストを取得します。
groupid:グループ ID
eproute create <groupid> <endpointid> 指定したグループ IDにユーザ IDを関連付けます。
endpointid:ユーザ ID
eproute delete <"type"> <"data"> ユーザ情報とグループ情報を関連付けたリストを削除します。
<リストに登録されているユーザを削除する場合> "type":"ep"を指定 "data":ユーザ IDを指定
<リストに登録されているグループを削除する場合> "type":"gp"を指定 "data":グループ IDを指定
eproute delete <groupid> <endpointid> 指定したグループ IDとユーザ IDに該当するデータをリストから削除します。
confmaster
説明: Presentation ミーティングに割当てられているアクセスリストの取得、Presenter の変更を行います。
書式: confmaster list (confid)
Presentationミーティングに割当てられているアクセスリストを取得します。
confmaster change <confid> <endpointid> <bool> 指定したミーティング IDに該当するミーティングの Presenterを変更します。
confid:ミーティング ID endpointid:ユーザ ID bool:"true"または"false"を指定
"true"の場合、指定された endpointを Presenterに設定 "false"の場合、指定された endpointを Observerに設定
buddy
説明: ユーザのバディ(コンタクト)のリストの取得/作成/削除を行います。
書式: buddy list (endpoint_id) ユーザに割当てられているバディリストを取得します。
buddy create <endpoint_id> <type> <data> [<type> <data> [...]] ユーザにバディを作成します。
2.6. ユーザ/グループリストコマンド
34
VN-M004-024
<バディ IDを指定する場合> "type":"bid"を指定 "data":登録するバディ IDを指定
<ユーザ IDを指定する場合> "type":"id"を指定 "data":登録するユーザ IDを指定
<H.323エリアスを登録する場合> "type":"h323"を指定 "data":登録する H.323エリアスを指定
<E.164番号を登録する場合> "type":"e164"を指定 "data":登録する E.164番号を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する IPアドレスを指定
<通知する状態を登録する場合> "type":"notify"を指定 "data":通知する状態(1[NONE]|2[ENABLE]|3[DISABLE])を指定
<表示名を登録する場合> "type":"display"を指定 "data":登録する表示名を指定
<表示状態を登録する場合> "type":"visible"を指定 "data":表示状態(1[VISIBLE]|2[HIDE])を指定
<削除状態を登録する場合> type":"delete"を指定 data":削除状態(1[NORMAL])を指定
buddy change <endpoint_id> <type> <data> [<type> <data> [...]] バディ情報を変更します。 指定する"type"と"data"は buddy create書式と同様です。
buddy delete <endpoint_id> bid <buddy_id> バディ情報を削除します。 指定する"endpoint_id"と"buddy_id"は buddy create書式と同様です。
buddygroup
説明: ユーザのバディグループのリストの取得/作成/削除を行います。
書式: buddygroup list (endpoint_id) ユーザに割当てられているバディグループのリストを取得します。
buddygroup create <endpoint_id> <type> <data> [<type> <data> [...]] ユーザにバディグループを作成します。
<バディグループ IDを指定する場合>
2.6. ユーザ/グループリストコマンド
35
VN-M004-024
"type":"gid"を指定 "data":登録するバディグループ IDを指定
<バディグループ名を指定する場合> "type":"gname"を指定 "data":登録するバディグループ名を指定
buddygroup change <endpoint_id> <type> <data> [<type> <data> [...]] バディグループ名を変更します。 指定する"type"と"data"は buddybroup create書式と同様です。
buddygroup delete <endpoint_id> gid <group_id> バディグループを削除します。
buddygroupuser
説明: ユーザのバディグループに属するバディのリストの取得/作成/削除を行います。
書式: buddygroupuser list (endpoint_id) ユーザに割当てられているバディグループに属するバディのリストを取得します。
buddygroupuser create <endpoint_id> <type> <data> [<type> <data> [...]] バディグループに属するバディを割り当てします。
<バディグループ IDを指定する場合> "type":"gid"を指定 "data":登録するバディグループ IDを指定
<バディ IDを指定する場合> "type":"bid"を指定 "data":登録するバディ IDを指定
buddygroupuser delete <endpoint_id> gid <group_id> bid <buddy_number> バディグループからバディを削除します。
forwarding
説明: ユーザの転送設定の取得/作成/削除を行います。
書式: forwarding list (endpoint_id) ユーザに割当てられている転送設定のリストを取得します。
forwarding create (endpoint_id) <type> <data> [<type> <data> [...]] 転送設定を追加します。
<条件を指定する場合> "type":"condition"を指定 "data":condition_id(1:Busy|2:Registered|3:NotRegistered)を指定
<動作を指定する場合> "type":"action"を指定 "data":action_id(1:ACF|2:ARJ|3:CallForwarding)を指定
<H.323エリアスを登録する場合> "type":"h323"を指定
2.6. ユーザ/グループリストコマンド
36
VN-M004-024
"data":登録する H.323エリアスを指定
<E.164番号を登録する場合> "type":"e164"を指定 "data":登録する E.164番号を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する IPアドレスを指定
forwarding change (endpoint_id) <type> <data> [<type> <data> [...]] 転送設定を変更します。 指定する"type"と"data"は forwarding create書式と同様です。
forwarding create (endpoint_id) condition <condition_id> 転送設定を削除します。
tmpendpoint
説明: ユーザテンプレートのリストの取得/作成/変更/削除を行います。
書式: tmpendpoint list (template id) ユーザテンプレートのリストを表示します。
tmpendpoint create <type> <data> [<type> <data> [...]] ユーザテンプレートを作成します。
<テンプレート名を登録する場合> "type":"name"を指定 "data":登録するテンプレート名を指定
<デフォルトサーバを登録する場合> "type":"homeserver"を指定 "data":ホームサーバのサーバ id
<代替サーバを登録する場合> "type":"altserver"を指定 "data":代替サーバのサーバ id
<STの使用方法を登録する場合> "type": "sttype"を指定 "data": st_use_type(1:AUTO_PC|2:AUTO_GC|3:PC|4:GC|5:DIRECT)
<デフォルト STサーバを登録する場合> "type": "stsvr1"を指定 "data": デフォルト STサーバのサーバ id
<代替 STサーバを登録する場合> "type": "stsvr2"を指定 "data": 代替 STサーバのサーバ id
<STクライアントを登録する場合>
2.6. ユーザ/グループリストコマンド
37
VN-M004-024
"type": "stclient"を指定 "data": STクライアントのクライアント id
<個人帯域を登録する場合> "type": "maxbw" "data": 帯域 <VNC帯域を登録する場合> "type": "vncbw" "data": VNC帯域
<組織を登録する場合> "type":"org"を指定 "data":登録する組織を指定
tmpendpoint change <template id> <type> <data> [<type> <data> [...]] ユーザテンプレートを変更します。 指定する"type"と"data"は tmpendpoint create書式と同様です。
tmpendpoint delete <template id> ユーザテンプレートを削除します。
epspb
説明: ユーザの共有アドレス帳モードの取得/設定を行います。
書式: epspb list (endpointid) endpointid: ユーザ ID epspb change <endpointid> <spbid> endpointid: ユーザ ID spbid: 共有アドレス帳モード 1:NONE 2:H323ALIAS 3:E164NUMBER 4:IPADDRESS
2.7. サーバ設定コマンド
38
VN-M004-024
2.7. サーバ設定コマンド ここでは、サーバ設定コマンドについて記載します。
server
説明: サーバ情報を取得/登録/変更/削除します。
書式:
server details サーバ種別の ID情報を取得します。
server list (serverid) サーバ情報のリストを取得します。
serverid:サーバ ID
server create <"type"> <"data"> [<"type"> <"data"> [ .. ] ] サーバ情報を登録します。
<サーバ名を登録する場合> "type":"name"を指定 "data":登録するサーバ名を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する IPアドレスを指定
<プレフィックスを登録する場合> "type":"prefix"を指定 "data":登録するプレフィックスを指定
<サーバ種別を登録する場合> "type":"type"を指定 "data":登録するサーバ種別を指定
server change <serverid> <"type"> <"data"> [<"type"> <"data"> [ .. ] ] 指定したサーバ IDに該当するサーバ情報を変更します。 指定する"type"と"data"は server create書式と同様です。
server delete <serverid> [force <”bool”>] 指定したサーバ IDに該当するサーバ情報を削除します。 "force":削除時に整合性を取る場合に指定します。 デフォルトサーバに指定しているユーザがある場合、 このオプションで true を指定しないとエラーになり削除出来ません。 "bool":"true"または"false"を指定
startservice
説明: ミーティングサーバを開始します。
書式:
startservice
2.7. サーバ設定コマンド
39
VN-M004-024
stopservice 説明:
ミーティングサーバを停止します。 書式:
stopservice
config
説明: サーバ設定を取得/登録/変更/削除します。
書式:
config list (key) サーバ設定を取得します。
config create <type> <data> [<type> <data> [...]] サーバ設定を追加します。
<設定キーを登録する場合> "type":"key"を指定 "data":登録するキーを指定
<設定値を登録する場合> "type":"value"を指定 "data":登録する値を指定
<有効/無効を登録する場合> "type":"enable"を指定 "data":登録する有効/無効を指定
<設定の日本語名を登録する場合> "type":"ja_name"を指定 "data":登録する設定の日本語名を指定
<設定の日本語名を登録する場合> "type":"ja_description"を指定 "data":登録する設定の日本語説明を指定
<設定の英語名を登録する場合> "type":"en_name"を指定 "data":登録する設定の英語名を指定
<設定の日本語名を登録する場合> "type":"en_description"を指定 "data":登録する設定の英語説明を指定
config change <type> <data> [<type> <data> [...]] サーバ設定を変更します。 指定する"type"と"data"は config create書式と同様です。
config delete (key) サーバ設定を削除します。
2.7. サーバ設定コマンド
40
VN-M004-024
stserver 説明:
VNSTサーバ情報を取得/登録/変更/削除します。 書式:
stserver list (st_server_id)
VNSTサーバ情報のリストを取得します。
stserver create <type> <data> [<type> <data> [...]] VNSTサーバ情報を追加します。
<VNSTサーバ IDを登録する場合> "type":"sid"を指定 "data":登録する VNSTサーバ IDを指定
<VNSTサーバ名を登録する場合> "type":"name"を指定 "data":登録する VNSTサーバ名を指定
<VNSTサーバ表示名を登録する場合> "type":"display"を指定 "data":登録する VNSTサーバ表示名を指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する VNSTサーバの IPアドレスを指定
<ポートを登録する場合> "type":"port"を指定 "data":登録するポートを指定
stserver change <type> <data> [<type> <data> [...]]
VNSTサーバ情報を変更します。 指定する"type"と"data"は stserver create書式と同様です。
stserver delete <st_server_id> [<alt_sid> <alt_st_server_id>]
VNSTサーバ情報のを削除します。必要ならば代わりのサーバを指定します。
stclient 説明:
VNSTグループクライアントを取得/登録/変更/削除します。 書式:
stclient list (st_client_id)
VNSTグループクライアントのリストを取得します。
stclient create <type> <data> [<type> <data> [...]] VNSTグループクライアントを作成します。
<VNSTグループクライアント IDを登録する場合> "type":"cid"を指定 "data":登録する VNSTグループクライアント IDを指定
<VNSTグループクライアント名を登録する場合> "type":"name"を指定
2.7. サーバ設定コマンド
41
VN-M004-024
"data":登録する VNSTグループクライアント名を指定
<接続するデフォルトの VNSTサーバ IDを登録する場合> "type":"sid1"を指定 "data":登録するデフォルトの VNSTサーバ IDを指定
<接続するセカンダリの VNSTサーバ IDを登録する場合> "type":"sid2"を指定 "data":登録するセカンダリの VNSTサーバ IDを指定
<IPアドレスを登録する場合> "type":"ip"を指定 "data":登録する VNSTグループクライアントの IPアドレスを指定
stclient change <type> <data> [<type> <data> [...]]
VNSTグループクライアント情報を変更します。 指定する"type"と"data"は stclient create書式と同様です。
stclient delete <st_client_id> [<alt_cid> <alt_st_client_id>]
VNSTグループクライアントを削除します。 必要ならば代理のグループクライアントを指定します。
ldapconfig
説明: LDAPサーバ設定を取得/登録/変更/削除します。
書式:
ldapconfig list (ldapid) LDAPサーバ設定を取得します。
ldapconfig create <type> <data> [<type> <data> [...]]
LDAPサーバ設定を追加します。
<LDAPサーバアドレスを登録する場合> "type":"laddr"を指定 "data":LDAPサーバのアドレス
<LDAPサービスのポートを登録する場合> "type":"lport"を指定 "data":LDAPサービスのポート
<LDAPサーバ接続時のアカウントを登録する場合> "type":"rootname"を指定 "data":LDAPサーバのアカウント
<LDAPサーバ接続時のパスワードを登録する場合> "type":"root_pass"を指定 "data":上記アカウントのパスワード
<同期するユーザの suffixを登録する場合> "type":"lsuffix"を指定 "data":suffix
2.7. サーバ設定コマンド
42
VN-M004-024
<同期するユーザの filterを登録する場合> "type":"lfilter"を指定 "data":filter
<同期する LDAP属性名とログイン名をマッピングする場合> "type":"mp_name"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名と H323エリアスをマッピングする場合> "type":"mp_h323"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名と E164エリアスをマッピングする場合> "type":"mp_e164"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名とメールアドレスをマッピングする場合> "type":"mp_mail"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名と名をマッピングする場合> "type":"mp_fname"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名とミドルネームをマッピングする場合> "type":"mp_mname"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名と姓をマッピングする場合> "type":"mp_lname"を指定 "data":同期する LDAP属性名
<同期する LDAP属性名と IPアドレスをマッピングする場合> "type":"mp_addr"を指定 "data":同期する LDAP属性名
<同期するユーザのテンプレートを登録する場合> "type":"tempid"を指定 "data":テンプレート id
ldapconfig change <ldapid> <type> <data> [<type> <data> [...]]
LDAPサーバ設定を変更します。 指定する"type"と"data"は ldapconfig create書式と同様です。
ldapconfig delete <ldapid>
LDAPサーバ設定を削除します。
2.8. 組織設定コマンド
43
VN-M004-024
2.8. 組織設定コマンド ここでは、組織設定コマンドについて記載します。
organization
説明: 組織情報を取得/登録/変更/削除します。
書式:
organization list (organization_id) 組織情報のリストを取得します。
organization_id:組織 ID
organization create <type> <data> 組織情報を登録します。
<組織名を登録する場合> "type":"name"を指定 "data":登録する組織名を指定
organization change <organization_id> <type> <data> 指定した組織 ID に該当する組織情報を変更します。 指定する"type"と"data"は organization create 書式と同様です。
organization delete <organization_id> 指定した組織 ID に該当するグループを削除します。
orglicense
説明: 組織ライセンス情報を取得/変更します。
書式:
orglicense list (organization_id) 組織ライセンス情報のリストを取得します。
organization_id:組織 ID
orglicense change <organization_id> <product_code> <number_of_license> 組織ライセンス情報を変更します。
organization_id:組織 ID product_code:製品コード number_of_license:ライセンス数