付録G.12　nnmcommunication.ovpl

SYNOPSIS

nnmcommunication.ovpl -h|-help

nnmcommunication.ovpl addCertificate (-default|-region (<name>|<uuid>)| -nodeSetting (<name>|<uuid>))(-cert <cert_file>)

nnmcommunication.ovpl addCommunity (-default|-region <region>) -community <value> [-ordering <order>]

nnmcommunication.ovpl addCredential (-default|-region <region>| -nodeSetting <nodeName>) -type (SHELL|VMWARE|CISCOACI) -username <username> -password <password>

nnmcommunication.ovpl addSnmpV3Setting (-default | -region (<name>|<uuid>)) -snmpV3Setting (<name>|<uuid>)

nnmcommunication.ovpl createAddressRange [-uuid <uuid>] -region <region> -range <ip_range>

nnmcommunication.ovpl createHostnameFilter -hostname <pattern> -region <region> [-uuid <uuid>]

nnmcommunication.ovpl createNodeSettings -name <name> [-addressDiscovery (true|false)] [-description <description>] [-icmpEnabled (true|false)] [-icmpRetries <number>] [-icmpTimeout <timeout>] [-managementAddress <ip>] [-shellCredential <credential>] [-shellUser <username>] [-snmpCommunity <string>] [-snmpEnabled (true|false)] [-snmpGetBulk (true|false)] [-snmpPort <port>] [-snmpPreferredVersion (V1|V2C|V3)] [-snmpProxyAddress <ip>] [-snmpProxyPort <port>] [-snmpRetries <number>] [-snmpTimeout <timeout>] [-snmpV3Setting (<name>|<uuid>)] [-snmpWriteCommunity <community_string>] [-uuid <uuid>]

nnmcommunication.ovpl createRegionSettings -name <name> -ordering <order> [-addressDiscovery (true|false)] [-addressFilter <filter>] [-description <description>] [-hostnameFilter <filter>] [-icmpEnabled (true|false)] [-icmpRetries <number>] [-icmpTimeout <timeout>] [-shellCredential <credential>] [-shellUser <username>] [-snmpCommunities <strings>] [-snmpEnabled (true|false)] [-snmpGetBulk (true|false)] [-snmpPort <port>] [-snmpProxyAddress <ip>] [-snmpProxyPort <port>] [-snmpRetries <number>] [-snmpSecurityLevel (COMMUNITY_ONLY|COMMUNITY|NO_AUTH_NO_PRIV|AUTH_NO_PRIV|AUTH_PRIV|COMMUNITY_ONLY_V1)] [-snmpTimeout <timeout>] [-snmpV3Settings (<name>|<uuid>)] [-snmpWriteCommunity <community_string>] [-uuid <uuid>]

nnmcommunication.ovpl createSnmpV3Settings -name <name> -username <name> [-authPass <string>] [-authProtocol (HMAC_MD5_96|HMAC_SHA_1)] [-contextName <string>] [-privPass <string>] [-privProtocol (DES_CBC|TripleDES|AES_128|AES_192|AES_256)] [-uuid <uuid>]

nnmcommunication.ovpl delete (-region <region>| -nodeSetting <nodeSetting>| -snmpV3Setting <v3Setting>)

nnmcommunication.ovpl deleteAddressRange (-region (<name>|<uuid>) | -range <ip_range> | -uuid <uuid>)

nnmcommunication.ovpl deleteHostnameFilter (-hostname <pattern> -region <region> | -uuid <uuid>)

nnmcommunication.ovpl listAddressRanges [-range <ip_range>] [-region (<name>|<uuid>)] [-uuid <uuid>]

nnmcommunication.ovpl listCertificates (-default|-region (<name>|<uuid>)| -nodeSetting (<name>|<uuid>))

nnmcommunication.ovpl listCommunities (-default|-region <region>)

nnmcommunication.ovpl listDefaults

nnmcommunication.ovpl listCredentials (-default|-region <region>| -nodeSetting <nodeName>)[-type(SHELL|VMWARE|CISCOACI)]

nnmcommunication.ovpl listEffective-node (<name>|<uuid>)

nnmcommunication.ovpl listHostnameFilters (-hostname <pattern> -region <region>) |(-uuid <uuid>)

nnmcommunication.ovpl listNodeSettings -name <name>

nnmcommunication.ovpl listRegionSettings [-name <name>]

nnmcommunication.ovpl listSnmpAgentSettings [-node (<name>|<uuid>)]

nnmcommunication.ovpl listSnmpV3Settings [(-name <name>|-uuid <uuid>)]

nnmcommunication.ovpl listWebAgentSettings [-node (<name>|<uuid>)]

nnmcommunication.ovpl removeCertificate (-default|-region (<name>|<uuid>)| -nodeSetting (<name>|<uuid>)) (-uuid <uuid>|-fingerPrint <fingerPrint>| -serialNumber <serialNumber>)

nnmcommunication.ovpl removeCommunity (-default|-region <region>) (-community <value>|-ordering <order>) -uuid <uuid>: The object unique identifier.

nnmcommunication.ovpl removeCredential (-default|-region <region>| -nodeSetting <nodeName>) -type (SHELL|VMWARE|CISCOACI) [-username <username>] [-password <password>]

nnmcommunication.ovpl removeSnmpV3Setting (-default | -region (<name>|<uuid>)) -snmpV3Setting (<name>|<uuid>)

nnmcommunication.ovpl updateCredential (-default | -region <region>| -nodeSetting <nodeName>) -type (VMWARE|CISCOACI) (-username <username> | -password <password>)

nnmcommunication.ovpl updateDefaults [-addressDiscovery (true|false)] [-default] [-icmpRetries <number>] [-icmpTimeout <timeout>] [-interfaceMatcher <value>] [-managementAddressSelection <ALG1,ALG2,ALG3>] [-preferIPVersion (IPv4|IPv6|IPAny)] [-shellCredential <credential>] [-shellUser <username>] [-snmpCommunities <strings>] [-snmpGetBulk (true|false)] [-snmpPort <port>] [-snmpProxyAddress <ip>] [-snmpProxyPort <port>] [-snmpRetries <number>] [-snmpSecurityLevel (COMMUNITY_ONLY|COMMUNITY|NO_AUTH_NO_PRIV|AUTH_NO_PRIV|AUTH_PRIV|COMMUNITY_ONLY_V1)] [-snmpTimeout <timeout>] [-snmpV3Settings (<name>|<uuid>)] [-snmpWriteCommunity <community_string>]

nnmcommunication.ovpl updateSnmpAgentSettings -node (<name> | <uuid>) [-address <ip>] [-community <string>] [-enabled (true|false)] [-mode (AUTO|LOCKED)] [-port <port>] [-retries <integer>] [-snmpProxyAddress <ip>] [-snmpProxyPort <port>] [-timeout <duration>] [-version (V1|V2C|V3)] [-writeCommunity <string>]

nnmcommunication.ovpl updateNodeSettings -nodeSetting (<name>|<uuid>) [-addressDiscovery (true|false)] [-description <description>] [-icmpEnabled (true|false)] [-icmpRetries <number>] [-icmpTimeout <timeout>] [-managementAddress <ip>] [-name <newName>] [-shellCredential <credential>] [-shellUser <username>] [-snmpCommunity <string>] [-snmpEnabled (true|false)] [-snmpGetBulk (true|false)] [-snmpPort <port>] [-snmpPreferredVersion (V1|V2C|V3)] [-snmpProxyAddress <ip>] [-snmpProxyPort <port>] [-snmpRetries <number>] [-snmpTimeout <timeout>] [-snmpV3Setting (<name>|<uuid>)] [-snmpWriteCommunity <community_string>]

nnmcommunication.ovpl updateRegionSettings -region (<name>|<uuid>) [-addressDiscovery (true|false)] [-addressFilter <filter>] [-description <description>] [-hostnameFilter <filter>] [-icmpEnabled (true|false)] [-icmpRetries <number>] [-icmpTimeout <timeout>] [-name <newName>] [-ordering <integer>] [-shellCredential <credential>] [-shellUser <username>] [-snmpCommunities <strings>] [-snmpEnabled (true|false)] [-snmpGetBulk (true|false)] [-snmpPort <port>] [-snmpProxyAddress <ip>] [-snmpProxyPort <port>] [-snmpRetries <number>] [-snmpSecurityLevel (COMMUNITY_ONLY|COMMUNITY|NO_AUTH_NO_PRIV|AUTH_NO_PRIV|AUTH_PRIV|COMMUNITY_ONLY_V1)] [-snmpTimeout <timeout>] [-snmpV3Settings (<name>|<uuid>)] [-snmpWriteCommunity <community_string>]

nnmcommunication.ovpl updateSnmpV3Setting -snmpV3Setting (<name>|<uuid>) [-authPass <string>] [-authProtocol (HMAC_MD5_96|HMAC_SHA_1)] [-contextName <string>] [-name <newName>] [-privPass <string>] [-privProtocol (DES_CBC|TripleDES|AES_128|AES_192|AES_256)] [-username <name>]

nnmcommunication.ovpl updateWebAgentSettings -node (<name>|<uuid>) [-mode <AUTO>|<LOCKED>] [-agentEnabled (true|false)] [-username <string>] [-password <string>] [-port <port>] [-scheme (HTTP|HTTPS)] [-timeout <duration>] [-cert <cert_file>]

DESCRIPTION

nnmcommunication.ovplコマンドラインの一般的なフォーマットは次のとおりです。

nnmcommunication.ovpl <command> <options>

下記の「Commands」項には，使用可能なコマンドの選択肢が一覧表示されています。同様に「Options」項には，各コマンドで使用可能なオプションが一覧表示されています。多くのコマンドで類似のオプションを使用できます。各コマンドで使用できる正しいオプションについては，上記の「SYNOPSIS」項を参照してください。

Commands

-h | -help

コマンドの使用方法を表示します。

addCertificate

デバイスの信頼済み証明書を通信の設定のデフォルト，特定のノード，または領域の設定に追加します。

addCommunity

デフォルトまたは領域の設定にコミュニティ文字列を追加します。順序が設定されていない場合，指定したコミュニティ文字列は最後に試行されます。

addCredential

デバイスの資格証明を通信の設定のデフォルト，特定ノード，または領域の設定に追加します。

addSnmpV3Setting

デフォルト設定または領域の設定に指定されたSNMPv3の設定を割り当てます。

createAddressRange

領域<region>に新しいアドレス範囲のエントリを作成します。領域には複数のアドレス範囲を設定できます。

createHostnameFilter

新しいホスト名フィルターエントリを作成します。

createNodeSettings

新しい特定ノードの設定を作成します。

createRegionSettings

新しい領域の設定を作成します。

createSnmpV3Settings

新しいSNMPv3設定を作成します。

delete

領域の設定，特定ノードの設定，またはSNMPv3の設定を削除します。

deleteAddressRange

一つ以上のアドレス範囲のエントリを削除します。

deleteHostnameFilter

一つ以上のホスト名フィルターのエントリを削除します。

listAddressRanges

アドレス範囲のエントリを一覧表示します。

listCertificates

通信の設定のデフォルト，特定ノード，または領域の設定に設定された，デバイスの信頼済み証明書のリストを表示します。

listCommunities

デフォルトまたは領域の設定のコミュニティ文字列を一覧表示します。

listCredentials

通信の設定のデフォルト，特定のノード，または領域の設定に設定された，デバイスの資格証明リストを表示します。

listDefaults

デフォルトの通信の設定を一覧表示します。

listEffective

ノードに設定されている有効な通信の設定を一覧表示します。

listHostnameFilters

ホスト名フィルターのエントリを一覧表示します。

listNodeSettings

特定ノードの設定を一覧表示します。

listRegionSettings

設定済みの領域を一覧表示します。領域名が指定されている場合は，その領域だけを一覧表示します。領域名が指定されていない場合は，すべての領域を一覧表示します。

listSnmpAgentSettings

ローカルNNMiサーバーで管理しているSNMPエージェントのアクティブな設定を一覧表示します。

listWebAgentSettings

ローカルのNNMi管理サーバーによって管理されるすべてのWeb Agentの設定を表示します。特定ノードで実行されているWeb Agentのリストを表示するには，ノードのホスト名またはUUIDをコマンドで指定します。

listSnmpV3Settings

SNMPv3設定を一覧表示します。固有名またはUUIDが指定されている場合は，その値に一致するSNMPv3設定だけを一覧表示します。固有名またはUUIDが指定されていない場合は，すべてのSNMPv3設定を一覧表示します。

removeCertificate

通信の設定のデフォルト，特定ノード，または領域に設定されているデバイスの信頼済み証明書を削除します。

removeCommunity

デフォルトまたは領域の設定から，コミュニティ文字列を削除します。

removeCredential

通信の設定のデフォルト，特定ノード，または領域に設定されているデバイスの資格証明を削除します。

removeSnmpV3Setting

デフォルトまたは領域の設定から，指定したSNMPv3設定を削除します。

updateSnmpAgentSettings

ローカルのNNMiサーバーが管理するノードのエージェントの設定を直接更新します。エージェントの設定を直接更新すると，コマンドに-mode AUTO引数を指定しない限り，エージェントのモードがLOCKED になります。

updateCredential

通信の設定のデフォルト，特定ノード，または領域に設定されているデバイスの資格証明を更新します。

updateDefaults

デフォルトの通信の設定フィールドを更新します。

updateNodeSettings

特定ノードの設定のフィールドを更新します。

updateRegionSettings

領域設定のフィールドを更新します。

updateSnmpV3Setting

SNMPv3設定を変更します。

updateWebAgentSettings

ローカルのNNMi管理サーバーによって管理されるノードでホストされるWeb Agentの設定を直接更新します。エージェントの設定を直接更新する場合，コマンドで-mode AUTO引数を指定しないときは，エージェントモードがLOCKEDになります。値を指定しないで"-cert"オプションを指定すると，Web Agent設定から信頼済み証明書を削除できます。

Options

このセクションでは，上記のコマンドに共通のオプションを示します。

-address <ip>

ノードに使用する管理アドレスです。

-addressDiscovery (true|false)

true の場合，NNMiは古い管理アドレスが応答しなくなったときに，新しい管理アドレスを検出しようとします。

-addressFilter <filter>

領域に含まれるノードをアドレスの範囲で指定します。例えば，10.1.0.0/16, 192.168.1-20.* または fc00::/7です。複数のエントリはセミコロンで区切ります。

-authPass <string>

SNMPv3認証パスフレーズです。

-authProtocol (HMAC_MD5_96|HMAC_SHA_1)

SNMPv3 認証プロトコルです。

-cert <cert_file>

信頼済み証明書ファイルに対する完全修飾パスです。サポートされる信頼済み証明書ファイルの拡張子は，.pem，.crt，.cer，および.derです。

-community <string>

コミュニティ文字列です。

-contextName <string>

SNMPv3コンテキスト名です。

-default

add/update/removeオプションを指定した場合にデフォルト設定の値を変更します。listオプションの場合は，デフォルト設定を列挙します。

-description <description>

設定の説明です。

-enabled (true|false)

SNMPエージェントの有効，無効を設定します。

-fingerPrint <fingerPrint>

信頼済み証明書の公開鍵のフィンガープリントです。

-hostnameFilter <filter>

含まれるノードのホスト名のパターンです。例えば，*.usa.myco.comです。

-icmpEnabled (true|false)

trueの場合はICMP通信を有効にし，falseの場合は無効にします。

-icmpRetries <number>

ICMPのリトライ数です。

-icmpTimeout <timeout>

ミリ秒単位でのICMPのタイムアウトです。

-interfaceMatcher <value>

優先管理アドレスとして使用するインタフェースに一致する式です。

-managementAddress <ip>

ノードに使用する管理アドレスです。

-managementAddressSelection <ALG1,ALG2,ALG3>

管理アドレス選択アルゴリズムを実行する順番です。有効な値は，LOW_LOOPBACK, HIGH_LOOPBACK, SEED, またはINTERFACEです。INTERFACEを指定する場合は，<interfaceMatcher>パラメータも指定する必要があります。

-mode (AUTO|LOCKED)

エージェントのモードです。AUTOは設定からの適用を意味します。LOCKEDはユーザーによる明示的な設定を意味します。

-name <name>

名前で出力をフィルタリングします; ワイルドカードとして * と ? がサポートされています。

-name <name>

設定名です。

-name <newName>

更新後の名前です。

-node (<name>|<uuid>)

ノード名で出力をフィルタリングします; FQDN，短縮名，IPアドレス，およびUUIDがサポートされています。

-nodeSetting (<name>|<uuid>)

特定ノードの設定を指定します; 有効な入力はターゲットホスト名またはUUIDです。

-ordering <integer>

設定の優先順序です。設定は，1から大きい数値へと，優先順序に従って試行されます。同じ優先順序を持つ2つの項目があるとエラーになります。

-password <password>

デバイス通信のパスワードです。

-port <port>

SNMPエージェントのUDPポートです。

-preferIPVersion (IPv4|IPv6|IPAny)

（NNMi Advancedだけ）優先するIPバージョン設定です。

-privPass <string>

SNMPv3プライバシパスフレーズです。

-privProtocol (DES_CBC|TripleDES|AES_128|AES_192|AES_256)

SNMPv3プライバシプロトコルです。

-range <ip_range>

IPアドレス範囲です。例えば，192.168.1.0/24や192.168.1-10.*です。

-retries <integer>

SNMPのリトライ数です。

-region (<name>|<uuid>)

領域を指定します。有効な値は領域名またはUUIDです。

-serialNumber <serialNumber>

信頼済み証明書のシリアル番号です。

-shellCredential <credential>

デバイスの資格証明のパスワードです。

-shellUser <username>

デバイスの資格証明のユーザー名です。

-snmpCommunities <strings>

セミコロンで区切られたSNMP読み取りコミュニティ文字列のリストです。Linuxプラットフォーム上のシェルは，セミコロンを特殊文字として扱います。 したがって，セミコロンが特殊文字として解釈されないように，リストを引用符で囲む必要があります。

-snmpCommunity <string>

ノードに使用するSNMPコミュニティです。

-snmpEnabled (true|false)

SNMP通信を有効または無効にします。

-snmpGetBulk (true|false)

trueの場合，NNMiはSNMPv2c GetBulkコマンドを使用します。

-snmpPort <port>

SNMP通信に使用するポートです。

-snmpPreferredVersion (V1|V2C|V3)

使用するSNMP優先バージョンです。

-snmpProxyAddress <ip>

使用するSNMPプロキシのIPアドレスです。SNMPプロキシを利用できるようにするには，SNMPプロキシポートも指定する必要があります。

-snmpProxyPort <ip>

SNMPプロキシによる通信に使用するポートです。SNMPプロキシを利用できるようにするには，SNMPプロキシアドレスも指定する必要があります。

-snmpRetries <number>

SNMPのリトライ数です。

-snmpSecurityLevel (COMMUNITY_ONLY|COMMUNITY|NO_AUTH_NO_PRIV|AUTH_NO_PRIV|AUTH_PRIV|COMMUNITY_ONLY_V1)

SNMP最小セキュリティレベルです。

-snmpTimeout <timeout>

ミリ秒単位でのSNMPのタイムアウトです。

-snmpV3Setting (<name>|<uuid>)

名前またはUUIDによりSNMPv3設定を指定します。

-snmpV3Settings (<name>|<uuid>)

名前またはUUIDによりSNMPv3設定を指定します。

-snmpWriteCommunity <community_string>

SNMP書き込みコミュニティ文字列です。

-timeout <duration>

SNMP AgentまたはWeb Agentのタイムアウトです。SNMP Agentの場合，1秒を1000またはPT1S，Web Agentの場合は1秒をPT1Sの形式で指定します。

-type <SHELL|VMWARE|CISCOACI>

資格情報のタイプ。有効な値はSHELL，VMWARE, CISCOACIです。

-username <name>

この設定のユーザー名です。

-uuid <uuid>

オブジェクトの一意の識別子です。

-version (V1|V2C|V3)

このエージェントが使用するSNMPバージョンです。有効な値はV1，V2CまたはV3です。

-writeCommunity <string>

SNMP書き込みコミュニティ文字列です。

-agentEnabled (true|false)

Web Agentの通信を有効または無効にします。

-scheme (HTTP|HTTPS)

Web Agentの通信に使用されるスキームです。

Additional Parameters

-fields <fields>

出力するフィールドを選択します。

-format <style>

テーブルデータの出力形式を設定します; 有効な値はTEXT, LIST, CSVまたはXMLです。

-http.host <host>

サーバーホストです;デフォルトはlocalhostです。

-http.port <port>

サーバーポートです;デフォルトは80です。

-p <password>

ユーザーのパスワードです。

-quiet

通常の出力を抑制し，エラーだけを出力します。

-u <username>

このコマンドを実行するためのユーザー名です。

EXAMPLES

米国内（ホスト名によって判定）のすべてのノードについて地域の設定を作成し，順序を10に設定します。

nnmcommunication.ovpl createRegionSettings -name UsaNodes -ordering 10 -hostnameFilter *.usa.myco.com.

一部のフィールドを設定するために上記で作成した領域設定を更新します。

nnmcommunication.ovpl updateRegionSettings -region UsaNodes -addressDiscovery true -snmpTimeout 200

上記で作成した領域設定を一覧表示します。

nnmcommunication.ovpl listRegionSettings -name UsaNodes

SNMPv3設定を作成します。

nnmcommunication.ovpl createSnmpV3Settings -name xyzSettings -username xyzUser -contextName xyzContext -authProtocol HMAC_MD5_96 -authPass myPass -privProtocol AES_192 -privPass myPrivPass

上記で作成したSNMPv3設定を一覧表示します。

nnmcommunication.ovpl listSnmpV3Settings -name xyzSettings

上記で作成したSNMPv3設定を使用して，ノードxyz.myco.comの特定ノードの設定を作成します。

nnmcommunication.ovpl createNodeSettings -name xyz.myco.com -snmpPreferredVersion V3 -snmpV3Setting xyzSettings

xyz.myco.comの有効なノードの設定を一覧表示します。

nnmcommunication.ovpl listEffective -node xyz.myco.com

xyz.myco.comのノードの設定を更新し，ICMPを無効にします。

nnmcommunication.ovpl updateNodeSettings -nodeSetting xyz.myco.com -icmpEnabled false

管理アドレスを更新し，ノードmynodeのエージェント設定をロックします。

nnmcommunication.ovpl updateSnmpAgentSettings -node mynode -address 192.168.1.1

mynodeのエージェント設定をロックせずに管理アドレスを更新します。

nnmcommunication.ovpl updateSnmpAgentSettings -node mynode -address 192.168.1.1 -mode AUTO

mynodeでホストされるWeb Agentを更新し，ポートを80に設定し，HTTPを使用し，3分でタイムアウトします。

nnmcommunication.ovpl updateWebAgentSettings -node mynode -port 80 -scheme HTTP -timeout PT3M

mynodeでホストされるWeb Agentを更新して，指定した信頼済み証明書を設定します。

nnmcommunication.ovpl updateWebAgentSettings -node mynode -cert /tmp/trustedCert-host1.pem

デフォルトの資格情報を新たに追加して，VMwareハイパーバイザーと通信します

nnmcommunication.ovpl addCredential -default -type VMWARE -username vmwareuser -password vmwarepass

デフォルトの資格情報をすべてリスト表示します。

nnmcommunication.ovpl listCredentials -default

デフォルトのVMWARE 資格情報を削除します。

nnmcommunication.ovpl removeCredential -default -type VMWARE

デフォルトのVMWARE資格情報を更新します。

nnmcommunication.ovpl updateCredential -default -type VMWARE -username username -password password

通信の設定のデフォルトの設定で，信頼済み証明書を追加します。

nnmcommunication.ovpl addCertificate -default -cert /tmp/trustedCert-host1.pem

通信の設定で「アメリカ」領域に設定された，すべての信頼済み証明書を表示します。

nnmcommunication.ovpl listCertificates -region Americas

デフォルトに設定された信頼済み証明書を対応するシリアル番号とともに削除します。

nnmcommunication.ovpl removeCertificate -default -serialNumber "1111111111"

AUTHOR

nnmcommunication.ovpl was developed by Micro Focus.

FILES

• Windows：%NNM_BIN%\nnmcommunication.ovpl

• Linux：$NNM_BIN/nnmcommunication.ovpl